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

Remote Payroll Runs API

The Payroll Runs API from Remote — 3 operation(s) for payroll runs.

Remote Payroll Runs API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.

3 operations 3 paths 16 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://gateway.remote.com/v1/
Authentication
HTTP Basic, HTTP Bearer, HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OAuth 2.0
Resource Areas
1

Authentication & Security 7

Remote Payroll Runs API declares 7 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (ClientToken). It accepts HTTP bearer tokens (CustomerAPIToken). It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes. It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes. It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes. It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes. By default, every request must be authenticated.

  • BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
  • ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
  • CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
  • OAuth2 — Authenticate using OAuth 2.0 protocol.
  • OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
  • OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
  • OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.

Paths & Operations 3

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

Payroll Runs 3
GET
/v1/payroll-runs/{payroll_run_id}
Show Company Payroll Runs
get_v1_payroll-runs_payroll_run_id 1 param → 200401404422
GET
/v1/payroll-runs/{payroll_run_id}/employee-details
Get Employee Details for a Payroll Run
get_v1_payroll-runs_payroll_run_id_employee-details 3 params → 200401404422
GET
/v1/payroll-runs
List Company Payroll Runs
get_v1_payroll-runs 3 params → 200401404422

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are PayrollRun (18 properties), EmployeeDetails (13 properties), Country (11 properties), MinimalPayrollRun (11 properties). Each schema is shown below with its type and property counts.

ActionError
object
3 properties 3 required
ParameterError
object
3 properties 3 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property 1 required
NullableDate
string
Optional UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
UnprocessableEntityResponse
object
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
Country
object
A supported country on Remote
11 properties 3 required
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
Date
string
UTC date in [ISO 8601](https://en.wikipedia.org/wiki/ISO8601) format
ListPayrollRunResponse
object
Response containing a list of payroll runs for the company. Each payroll run includes summary information but not per-employee breakdowns.
1 property
EmployeeDetails
object
Payroll cost breakdown for a single employee within a payroll run. All monetary amounts are represented as an object with amount (integer, in cents) and curren…
13 properties 12 required
PayrollRun
object
A payroll run represents a single payroll processing cycle for a company in a specific country and period. It progresses through statuses from preparation to f…
18 properties 16 required
CountrySubdivision
object
A subdivision of a supported country on Remote
3 properties 1 required
EmployeeDetailsResponse
object
Paginated response containing per-employee payroll cost breakdowns for a specific payroll run.
1 property 1 required
MinimalPayrollRun
object
A lightweight representation of a payroll run used in list responses. Contains summary information and the total cost, but not the per-employee breakdown or co…
11 properties 10 required
PayrollRunResponse
object
Response containing a single payroll run with full details including cost totals and employee breakdowns.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

remote-payroll-runs-api-openapi.yml Raw ↑

Other APIs Remote publishes across the network.

Remote Address Details API
Remote Administrative Details API
Remote Background Checks API
Remote Bank Account Details API
Remote Basic Information API
Remote Benefit Offers API
Remote Benefit Offers By Employment API
Remote Benefit Renewals API
Remote Benefits API
Remote Billing Address Details API
Remote Billing API
Remote Billing Documents API