Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nmbrs Payruns API

Payroll runs (payruns) and their results for a company.

Nmbrs Payruns API is one of 10 APIs that Nmbrs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payruns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0-modeled.

Requests are made against a single base URL, https://api.nmbrsapp.com.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0-modeled
Base URL
https://api.nmbrsapp.com
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

Nmbrs Payruns API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 5 scopes. An API key is passed in the header as X-Subscription-Key (subscriptionKey). By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 Authorization Code flow via identityservice.nmbrs.com.
  • subscriptionKey — Per-product subscription key generated in the Nmbrs developer portal, required on every request in addition to the OAuth bearer token.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Payruns 1

Payroll runs (payruns) and their results for a company.

GET
/api/companies/{companyId}/payruns
List payruns
listPayruns 1 param → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Payrun (5 properties). Each schema is shown below with its type and property counts.

Payrun
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nmbrs-payruns-api-openapi.yml Raw ↑

Other APIs Nmbrs publishes across the network.

Nmbrs SOAP EmployeeService (Legacy)
Nmbrs SOAP CompanyService (Legacy)
Nmbrs SOAP DebtorService (Legacy)
Nmbrs Absences API
Nmbrs Companies API
Nmbrs Employees API
Nmbrs Employments API
Nmbrs Salaries API
Nmbrs Wage Components API