---
title: "Get Payroll Run By Id"
method: GET
path: "/api/hris/v1/payroll-runs/{id}"
tags: ["Payroll Runs"]
---

# Get Payroll Run By Id

`GET /api/hris/v1/payroll-runs/{id}`

Returns a PayrollRun object with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — Whether to include custom fields in the response.
- `expand` string — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- HrisPayrollRun — The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.
  - `id` string, uuid, required
  - `remote_id` string, nullable, required — The third-party API ID of the matching object.
  - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
  - `raw_data` object, nullable — This is the Raw data
  - `custom_fields` object, nullable, required — The custom fields related to the model
  - `pay_group` string, nullable, required — The paygroup to which this pay cycle belongs to
  - `run_state` 'PAID' | 'DRAFT' | 'APPROVED' | 'FAILED' | 'CLOSED' | 'NOT_STARTED', nullable, required — The state of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.
  - `run_type` 'REGULAR' | 'OFF_CYCLE' | 'CORRECTION' | 'TERMINATION' | 'BONUS' | 'SIGN_ON_BONUS', nullable, required — The type of the payroll run. If the value is not one of the defined enum values, the original value passed through will be returned.
  - `start_date` string, nullable, required — The day and time the payroll run started.
  - `end_date` string, nullable, required — The day and time the payroll run ended.
  - `check_date` string, nullable, required — The day and time the payroll run was checked.
  - `payroll_run_calendar` string, nullable, required — The payroll run calendar to which which the payroll run belongs

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `404` — The requested resource was not found.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

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