---
title: "Get Payroll Calendar Run By Id"
method: GET
path: "/api/hris/v1/payroll-run-calendars/{id}"
tags: ["Payroll Run Calendars"]
---

# Get Payroll Calendar Run By Id

`GET /api/hris/v1/payroll-run-calendars/{id}`

Returns a PayrollRunCalendar 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

- HrisPayrollRunCalendar — The PayrollRunCalendar 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
  - `payroll_run_calendar_name` string, nullable, required — The name of the payroll run calendar
  - `pay_group` string, nullable, required — The paygroup to which this pay cycle belongs to
  - `pay_period_start_date` string, nullable, required — The day and time the payroll run is supposed to start.
  - `pay_period_end_date` string, nullable, required — The day and time the payroll run is supposed to end.
  - `pay_date` string, nullable, required — The day and time the by which payment is to be made.
  - `calendar_type` string, nullable, required — The type of the payroll run calendar

## 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)