---
title: "Get Compensation By Id"
method: GET
path: "/api/hris/v1/compensations/{id}"
tags: ["Compensation"]
---

# Get Compensation By Id

`GET /api/hris/v1/compensations/{id}`

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

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