Common ModelsEmployments

/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

expandenumOptional
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](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
employeestring or nullformat: "uuid"
The employee holding this position.
job_titlestring or null
The position's title.
pay_ratedouble or null
The position's pay rate.
pay_periodenum or null

The time period this pay rate encompasses.

  • HOUR - HOUR
  • DAY - DAY
  • WEEK - WEEK
  • EVERY_TWO_WEEKS - EVERY_TWO_WEEKS
  • SEMIMONTHLY - SEMIMONTHLY
  • MONTH - MONTH
  • QUARTER - QUARTER
  • EVERY_SIX_MONTHS - EVERY_SIX_MONTHS
  • YEAR - YEAR
pay_frequencyenum or null

The position’s pay frequency.

  • WEEKLY - WEEKLY
  • BIWEEKLY - BIWEEKLY
  • MONTHLY - MONTHLY
  • QUARTERLY - QUARTERLY
  • SEMIANNUALLY - SEMIANNUALLY
  • ANNUALLY - ANNUALLY
  • THIRTEEN-MONTHLY - THIRTEEN-MONTHLY
  • PRO_RATA - PRO_RATA
  • SEMIMONTHLY - SEMIMONTHLY
pay_currencyenum or null
The position's currency code. The currency code in ISO 4217 format.
pay_groupstring or nullformat: "uuid"
The employment's pay group
flsa_statusenum or null

The position’s FLSA status.

  • EXEMPT - EXEMPT
  • SALARIED_NONEXEMPT - SALARIED_NONEXEMPT
  • NONEXEMPT - NONEXEMPT
  • OWNER - OWNER
Allowed values:
effective_datedatetime or null
The position's effective date.
employment_typeenum or null

The position’s type of employment.

  • FULL_TIME - FULL_TIME
  • PART_TIME - PART_TIME
  • INTERN - INTERN
  • CONTRACTOR - CONTRACTOR
  • FREELANCE - FREELANCE
Allowed values:
remote_was_deletedbooleanRead-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 nullRead-only
remote_datalist of objects or nullRead-only

Field support by integration

See all supported fields

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