/employments/{id}
Returns an Employment object with the given id.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Path parameters
id
Headers
X-Account-Token
Token identifying the end user.
Query parameters
expand
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_remote_data
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_data
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
remote_fields
Deprecated. Use show_enum_origins.
show_enum_origins
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
id
remote_id
The third-party API ID of the matching object.
created_at
The datetime that this object was created by Merge.
modified_at
The datetime that this object was modified by Merge.
employee
The employee holding this position.
job_title
The position's title.
pay_rate
The position's pay rate.
pay_period
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_frequency
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_currency
The position's currency code. The currency code in ISO 4217 format.
pay_group
The employment's pay group
flsa_status
The position's FLSA status.
* `EXEMPT` - EXEMPT
* `SALARIED_NONEXEMPT` - SALARIED_NONEXEMPT
* `NONEXEMPT` - NONEXEMPT
* `OWNER` - OWNER
Allowed values:
effective_date
The position's effective date.
employment_type
The position's type of employment.
* `FULL_TIME` - FULL_TIME
* `PART_TIME` - PART_TIME
* `INTERN` - INTERN
* `CONTRACTOR` - CONTRACTOR
* `FREELANCE` - FREELANCE
Allowed values:
remote_was_deleted
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_mappings
remote_data