Skip to main content
GET
/
api
/
hris
/
v1
/
compensations
Get Compensations
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/compensations \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "custom_fields": {
        "category_group": "REG",
        "disability_type": "ASBERG",
        "hire_date": "1991-03-16T00:00:00",
        "hire_source": "REFER",
        "nationality": "USA",
        "original_hire_date": "1991-03-16T00:00:00"
      },
      "employee": "<any>",
      "pay_group": "<any>",
      "pay_rate": 77000,
      "pay_period": "YEAR",
      "pay_frequency": "MONTHLY",
      "pay_currency": "USD",
      "flsa_status": "EXEMPT",
      "start_date": "2022-12-15T00:00:00Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Headers

​
x-connector-token
string
required

Query Parameters

​
ids
string | null
​
employee_id
string | null
​
remote_id
string
​
include_raw_data
boolean
default:false
​
include_custom_fields
boolean
default:false
​
page_size
integer
default:50
Required range: 1 <= x <= 100
​
cursor
string
​
modified_after
string
​
expand
string

Response

​
cursor
string | null
required
Example:
​
page_size
integer
required
Example:
​
items
HrisCompensation · object[]
required