---
title: "Get Compensations"
method: GET
path: "/api/hris/v1/compensations"
tags: ["Compensation"]
---

# Get Compensations

`GET /api/hris/v1/compensations`

Returns a list of Compensation objects.

## Query parameters

- `ids` string, nullable — The ID of the compensations to fetch
- `employee_id` string, nullable — The ID of the employees to fetch compensation for
- `remote_id` string — The third-party API ID of the matching object.
- `pay_group_id` string, nullable — The ID of the pay groups to fetch compensation for
- `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.
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.
- `modified_after` string — If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
- `start_date_from` string — If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)
- `start_date_to` string — If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)
- `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

- PaginatedResponseHrisCompensation
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` HrisCompensation[], required — List of items in the current response
    - `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
    - `employee` string, nullable, required — The employee holding this position.
    - `pay_group` string, nullable, required — The employee's pay group.
    - `pay_rate` union, required — The position's pay rate in dollars.
      - integer
      - number
    - `pay_period` 'HOUR' | 'DAY' | 'WEEK' | 'EVERY_TWO_WEEKS' | 'EVERY_FOUR_WEEKS' | 'TWICE_PER_MONTH' | 'SEMIMONTHLY' | 'MONTH' | 'QUARTER' | 'EVERY_SIX_MONTHS' | 'YEAR' | '-', nullable, required — The time period this pay rate encompasses. If the value is not one of the defined enum values, the original value passed through will be returned.
    - `pay_frequency` 'HOURLY' | 'WEEKLY' | 'BIWEEKLY' | 'QUARTERLY' | 'SEMIANNUALLY' | 'ANNUALLY' | 'THIRTEEN-MONTHLY' | 'PRO_RATA' | 'SEMIMONTHLY' | 'MONTHLY' | 'FOURWEEKLY' | '-', nullable, required — The position's pay frequency. If the value is not one of the defined enum values, the original value passed through will be returned.
    - `pay_currency` string, nullable, required — The position's currency code.
    - `flsa_status` 'EXEMPT' | 'SALARIED_NONEXEMPT' | 'NONEXEMPT' | 'OWNER' | '-', nullable, required — The position's FLSA status. 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 position's start date.

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