Skip to main content
GET
/
api
/
hris
/
v1
/
compensations
/
{id}
Get Compensation By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/compensations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "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

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false
​
include_custom_fields
boolean
default:false
​
expand
string

Response

​
id
string<uuid>
required
Example:
​
remote_id
string | null
required
Example:
​
modified_at
string
required
Example:
​
custom_fields
object | null
required
Example:
​
employee
any
required
​
pay_group
any
required
​
pay_rate
required
Example:
​
pay_period
string | null
required
Example:
​
pay_frequency
string | null
required
Example:
​
pay_currency
string | null
required
Example:
​
flsa_status
string | null
required
Example:
​
start_date
string | null
required
Example:
​
raw_data
object | null
Example: