Pay & Compensation
Pay Items

List Pay Items

Changed on

Lists pay items for a company with optional filtering by employment, legal entity, date range, and pagination. Recurring pay items are not included; the monthly payments generated from them are.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
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: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, pay_item:read, pay_item:write, payroll, all:write, all:read)

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)

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

  • 51aa6655a32fRevision changes
    • info

      added the optional property /// to the response with the status

  • baab02e19e84Revision changes
    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status