Employments
Get Employment By Id
Returns an Employment object with the given id.
GET
/
api
/
hris
/
v1
/
employments
/
{id}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-connector-token
string
requiredPath Parameters
id
string
requiredQuery Parameters
include_raw_data
boolean
default: falseWhether to include the original data Bindbee fetched from the third-party to produce these models.
Response
200 - application/json
id
string
requiredremote_id
string | null
requiredThe third-party API ID of the matching object.
modified_at
string
requiredThis is the datetime that this object was last updated by Bindbee
raw_data
object | null
This is the Raw data
employee
string | null
requiredThe employee holding this position.
job_title
string | null
requiredThe position's title.
department
string | null
requiredThe position's department
division
string | null
requiredThe position's division
effective_date
string | null
requiredThe position's effective date.
employment_type
string | null
requiredThe 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.