Pay Items

List Pay Items

Lists pay items for a company with optional filtering by employment, legal entity, date range, and pagination. Neither recurring pay items nor the payments generated from them are included. Remote still pays those payments, and a one-off pay item is paid in addition to the payments generated for the same period.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage payroll runs (payroll)	View pay items (pay_item:read)	Manage pay items (pay_item:write)
Company-scoped access token (assertion)	Manage payroll runs (payroll)	View pay items (pay_item:read)	Manage pay items (pay_item:write)
Customer API token	Manage payroll runs (payroll)	View pay items (pay_item:read)	Manage pay items (pay_item:write)

get/v1/pay-items

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/pay-items
Auth
- OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: pay_item:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Authorization code: /auth/oauth2/authorize
  Token URL: /auth/oauth2/token scopes: all:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: pay_item:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:read
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Query parameters

employment_slugstring uuid

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Filter by employment slug

legal_entity_idstring uuid

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Filter by legal entity ID

effective_fromstring date

UTC date in ISO 8601 format

Example:2021-07-01

Filter pay items with effective_date >= given date (YYYY-MM-DD)

effective_tostring date

UTC date in ISO 8601 format

Example:2021-07-01

Filter pay items with effective_date <= given date (YYYY-MM-DD)

partner_external_idstring

Filters the results by the partner_external_id value the calling integration holds for the pay item; another integration's identifiers are never matched. Matching is exact, including case. A value can be held by one live pay item at a time, per integration and company; editing a pay item keeps its value on the new version. See Your own IDs on Remote records.

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "data": {
    "current_page": 1,
    "pay_items": [
      {
        "amount": 7200,
        "code": "overtime",
        "effective_date": "2026-03-11",
        "employment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "end_date": null,
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "provider_data": {
          "correction_effective_date": "2026-03-15",
          "hourly_rate": 2550,
          "hourly_rate_currency_code": "SGD",
          "pay_rate": 1.5,
          "shift_code": "DAY",
          "work_day_duration": 28800
        },
        "replaced_ids": []
      }
    ],
    "total_count": 1,
    "total_pages": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.