GET
/
api
/
hris
/
v1
/
employments
/
{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": "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>",
  "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
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.

include_custom_fields
boolean
default:
false

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.

Response

200
application/json
Successful Response

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

id
string
required
remote_id
string | null
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

custom_fields
object | null
required

The custom fields related to the model

raw_data
object | null

This is the Raw data

employee
any | null

The employee holding this position.

job_title
string | null

The position's title.

department
string | null

The position's department

division
string | null

The position's division

effective_date
string | null

The position's effective date.

employment_type
string | null

The position's type of employment. Possible values include: FULL_TIME, PART_TIME, INTERN, CONTRACTOR, FREELANCE, or - in cases where there is no clear mapping - the original value passed through.