GET
/
api
/
hris
/
v1
/
employments
/
{id}

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

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

custom_fields
object | null
required

The custom fields related to the model

id
string
required
modified_at
string
required

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

remote_id
string | null
required

The third-party API ID of the matching object.

department
string | null

The position's department

division
string | null

The position's division

effective_date
string | null

The position's effective date.

employee
any | null

The employee holding this position.

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.

job_title
string | null

The position's title.

raw_data
object | null

This is the Raw data