---
title: "Pay Runs"
method: GET
path: "/hris/pay-runs"
tags: ["Unified HRIS API"]
---

# Pay Runs

`GET /hris/pay-runs`

Pay Runs



<Warning>**Closed Beta Feature:** This endpoint is currently in closed beta. We're testing it with selected customers before its public release. If you're interested in learning more or getting early access, please reach out.</Warning>



Retrieve all pay runs for all legal entities, across all time.

## Query parameters

- `cursor` string — An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response.
- `page_size` integer — The number of results to return per page. Maximum is 250.
- `updated_after` string, date-time — Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, only changes to the returned record itself are considered.
- `include_deleted` 'true' | 'false' — By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too.
- `ignore_unsupported_filters` 'true' | 'false' — When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results.
- `ids` string — Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`.
- `remote_ids` string — Filter by a comma-separated list of remote IDs.
- `legal_entity_ids` string — Filter by a comma-separated list of legal entity IDs.

## Headers

- `X-Integration-Id` string, required

## Response `200`

GET /hris/pay-runs Positive response

- GetHrisPayRunsPositiveResponse
  - `status` 'success', required
  - `data` object, required
    - `next` string, nullable, required — Cursor string that can be passed to the `cursor` query parameter to get the next page. If this is `null`, then there are no more pages.
    - `results` object[], required
      - `id` string, required — The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
      - `remote_id` string, required — The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
      - `start_date` string, date-time, required — The start date of the pay run.
      - `end_date` string, date-time, required — The end date of the pay run.
      - `pay_date` string, date-time, required — The date of the pay run, when the pay was processed.
      - `status` object, required
        - `remote_label` string, required — The label of the payroll status how it appears in the remote system.
        - `unified_type` 'PENDING' | 'PROCESSING' | 'FAILED' | 'SKIPPED' | 'ROLLED_BACK' | 'COMPLETED_WITH_WARNINGS' | 'COMPLETED', nullable, required — The unified type, how Kombo categorizes this label.
      - `currency` string, nullable, required — The currency that the employee is paid in. Usually returned in [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).
      - `legal_entity_id` string, nullable, required — The Kombo ID of the employee’s legal entity. The ID can be used to retrieve the legal entity from the `get legal entities` endpoint.
      - `totals` object, required
        - `gross_pay` number, double, nullable, required — The gross pay of the pay run.
        - `net_pay` number, double, nullable, required — The net pay of the pay run.
        - `paid_amount` number, double, nullable, required — The paid amount of the pay run.
      - `changed_at` string, date-time, required — The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.
      - `remote_deleted_at` string, date-time, nullable, required — The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
      - `remote_data` object, nullable, required — Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set. Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: `{ "/companies": { ... }}` This is not available on all plans. Reach out to Kombo if you need it.

## Other responses

- `default` — The standard error response with the error codes for the HRIS use case.

---

[API](https://skmtc.net/kombo/apis/kombo-api.md) · [All operations](https://skmtc.net/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/fdcb894a4742/schema)