Skip to main content
GET
/
api
/
hris
/
v1
/
employments
/
{id}
Get Employment By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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"
  },
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "employee": "018abccc-3208-7b2d-8b86-927945f89a42",
  "job_title": "Chief Technology Officer",
  "department": "Engineering",
  "division": "Core",
  "effective_date": "2023-06-22T00:00:00Z",
  "employment_type": "FULL_TIME"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

​
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.

Example:

"manager[first_name,last_name]"

Response

Successful Response

The Employment object is used to represent a job position at a company.

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

This is the datetime that this object was last updated by Bindbee

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "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"
}
​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}
​
employee
any | null

The employee holding this position.

Example:

"018abccc-3208-7b2d-8b86-927945f89a42"

​
job_title
string | null

The position's title.

Example:

"Chief Technology Officer"

​
department
string | null

The position's department

Example:

"Engineering"

​
division
string | null

The position's division

Example:

"Core"

​
effective_date
string | null

The position's effective date.

Example:

"2023-06-22T00:00:00Z"

​
employment_type
enum<string>

The position's type of employment. If the value is not one of the defined enum values, the original value passed through will be returned.

Available options:
FULL_TIME,
PART_TIME,
INTERN,
CONTRACTOR,
FREELANCE,
REGULAR,
FURLOUGHED,
TERMINATED,
-
Example:

"FULL_TIME"