For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Employment object
          • GET/employments
          • GET/employments/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsEmployments

The Employment object

The Employment Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "employee": "string",
7  "job_title": "string",
8  "pay_rate": 1,
9  "pay_period": "HOUR",
10  "pay_frequency": "WEEKLY",
11  "pay_currency": "XUA",
12  "pay_group": "string",
13  "flsa_status": "EXEMPT",
14  "effective_date": "2023-01-01T00:00:00Z",
15  "employment_type": "FULL_TIME",
16  "remote_was_deleted": true,
17  "field_mappings": {},
18  "remote_data": [
19    {
20      "path": "string",
21      "data": {}
22    }
23  ]
24}
Was this page helpful?
Previous

/employer-benefits/{id}

Next

/employments

Built with

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

If an integration supports historical tracking of employments, it will be reflected in the data. If not, a new Employment object will be created whenever there is a change in job title or pay. The effective_date field should be used to order Employment objects, with the most recent date corresponding to the latest employment record for an employee.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
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
pay_frequencyenum or nullOptional
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
Allowed values:
effective_datedatetime or nullOptional
The position's effective date.
employment_typeenum or nullOptional
Allowed values:
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only