Skip to navigation

/employments/{id}

Returns an Employment object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandlist of enumsOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_databooleanOptional

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

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

show_enum_originsenumOptional

A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. Learn more

Response

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
employeestring or nullOptionalformat: "uuid"
The employee holding this position.
job_titlestring or nullOptional
The position's title.
pay_ratedouble or nullOptional
The position's pay rate.
pay_periodenum or nullOptional

The time period this pay rate encompasses. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=pay_period to receive the integration’s own value instead.

pay_frequencyenum or nullOptional

The position’s pay frequency. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=pay_frequency to receive the integration’s own value instead.

pay_currencyenum or nullOptional
The position's currency code. The currency code in ISO 4217 format.
pay_groupstring or nullOptionalformat: "uuid"
The employment's pay group
flsa_statusenum or nullOptional

The position’s FLSA status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=flsa_status to receive the integration’s own value instead.

Allowed values:
effective_datedatetime or nullOptional
The position's effective date.
employment_typeenum or nullOptional

The position’s type of employment. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass show_enum_origins=employment_type to receive the integration’s own value instead.

Allowed values:
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only

Field support by integration

See all supported fields

Use the /linked-accounts endpoint to pull platform support information