/employments

Returns a list of Employment objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
employee_idstringOptional
If provided, will only return employments for this employee.
expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
Allowed values:
include_deleted_databooleanOptional
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](https://docs.merge.dev/integrations/hris/supported-features/).
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).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
order_byenumOptional

Overrides the default ordering for this endpoint. Possible values include: effective_date, -effective_date.

Allowed values:
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_fieldsenumOptional

Deprecated. Use show_enum_origins.

remote_idstringOptional
The API provider's ID for the given object.
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

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1c71PqRhf+V5h86uuIqOjr1ZlOB0EEr0QK2Pbezp3MITmElU02bjYidvq/dzYJiLfWFj2Qtb2fxJA8Ic85e35vfrNcUOgLObNOrLFksbVtBcJDbp1YZ0HExSzAUFnbFkTMhgDzs5y7fWvbipMoElKh12TIvbglcWSdWJUApY/lJGQjhl5Fn15hoUJfgmIijCuLy8qj9Dpr2+IsnKBXc12RhOoloOzEMmRnfvWv/jrWPzaCOFZjKRJ/3MPbBOMXMfXv4aifE3jZAwWVpevLMgN47pj+5R5yVOg1QEEDFbr6EfN7jZWK4pNKZYw82knvu+PhXQXDCkjFXI5x5bB6vH90fFjOUdK7/+D4/Pu9rZvboRgebTm+yx1ItjoD994etKf2jX9g1w/u7YfrQ/th8mDfTHa3HB+2OoPO4dXgU/WqUdu7euYEp///X45/Om2cXthb7sNZ1b75NLUH7l5n4E6GD+3qxbk7vWj9eG8/fNrvNK6r9uDs8OJc7F3Ve3Gn3hOd2s6OtW0tS9I6+fW35QO5ghzFYzZKyVn6rh2Aj0ukZHKAiJWjZMiZuxNXdyCABxHCNN5xRVAJ0GNQ6XJQIyGDHNTpShGhVDNnv/0I/ni02r9NQOLjgYPHT3uHH5w4/XonCv257JgIF4LTSm+3anb9rPFUi2p3wDgMOVonSib4J9W3Tn61cDTSKHfoeKDQ2rYwXT+oP96IoaOY4pjCzpwIJRNe/o/MTpcYCJVeDE//cyJQY+uLPnabMIleFyQEqFDq+375ffs5IdQa3VLjrN5utK87NJKoNbpOA13msSRw+sXwiAuT5KhZpI+MeAxOrEAl8TM8u4mUGLqz19O+OMS814igd23Tsd+7tt8p8aPUYhYpiJ+FnIyEdLFkiymdSBawji2m34SjhbNtJSG7TfRnDJX2s3JlgXHOIHSxVSeyXXMv0urNodfqCR5F87IgvmbelyKJvpYCsV/gCiWUujCTgnOihZBi5trvXApfGLAE/o7rtXjdUwiGQrR6NLzO0Z4wexMVzeymjcuqMpAIaoxEIsjAliXgND8df/ZvAgMkYRz3dXyAMMQS1QrI8coFhe3r42kMkjMiHc3BvrIT5llgo2JCTZpqiYhOBBptv6gEc2X2N8w2hxmVTZjHchlmTriz25qGh43Ldcdzj6yuyoAQvA6SasnnaJlDype9fzCceUfXhRY3/laF3pwbNEBOWTgU9zRMLuDW6mP+2UJdmYlZmnrSLqs5qgEm7E2B5rO51NocegORKJlayAGRGyADo534Y4ei1EIpaATwCFrWoEXFni+LYn2cNsFVQjIgUucFXKHB6ebr703BJzFZHjQ3CinqhkpXBJy9RQ1FIlMECh1MscwNzTfMrMR4rBACInLncOZUv432WecYomRuqd8cdGkk4GeITjxS0TwdCi6q97vtzecCxQRxr5BCEiuieGFum1PIOf9Mg7139je7MFrAOM7IXWYG67R6BkjDbP7ZUAyJudeQBvBueMei1SvVuUg8GvJbPSdFK7RrZFT1sdUrdUGqECUVwzmcYY25YuPKVk8PQxCPfeWgBtiQFbLvVYlLAoCQiLgczHDNLNYcJAGjIXucBMzM+tDmWW2Hsb6hmpW6EgNGZWvnhoDN4c1N4wuPI/RELOeMKoJewL0vY1JsFN3utfulOsQueESNGY3o5IjmGpuCWe8LfodEAfTC5MQpqAFkrzZFuFnqL5IgIsxeNJybpi/vrh97kcRqShcCL+AMM7/rnrhfkfWPwDnzEiLS52jfooy/JhwnQEP2BCdgwDKnJyi8Ia4tp5CmbF4qNHm7hJCIW420/qY0wejYJSjFXD1U2+7TPDrPEOfNivH5xefqpPVvMHarUpu4LpExS6EMcM+bmRLRf/iMhrkMy7Aoxzi3awdDSRTkpFCFzuNsxFVcjUbMZdn2dQLWFnD/pdjwLfRLcDlmna2SLkuHpTpETAEvdSAEP91xX/quVe/8j0hA6Q3/jdJ5BfmzWKGkqgRmaEaE6oXkmF2Y1SFSwEKisB5mboZnrra+NIrzmlBLP/MYiab2czDDNjy9XBnZiJq6gmisb555ZpgGkLuGqudr6CVua0UppjlWwAAVbjKigG1JhUfM0KhtfeFXF2ZcuEwRJWkLuCdboS/Pg72mFxpGqhH5WhdFxJFsmjFHc2qui3H8X5q1Xpl3GYuQURVgc7S51jfFT3B+NDCf+A0QLVkcUOl3pMHGBjnC1cONlekT+k00VL4uRzOsirb2xvWKpPfS62koz35LPpHBzchAih0B6+Gd4IkqZc6KhuUcc60O7x+3ul73DqG3MMqiiLP0mQkDYpmjOrL34b46tI1uvr6BvT74dK+i0WDO0ixcdTg9OOoYuOY3HgikNFOu+ZTqDHBOt3vfb7sfbwrvfa+HwFq31E/SwD7bLk3U53mK+SRxO3V/EX5z1/gQYYX9gWs3xn2M9QdSU5xhbtKtrZGfMURIpbopltOQCMFAby7ORxXuoDlS3uk76EGsSh7L7k5UX1zAfasU/DXlKTO0r8LMbezaszBDp7MGktlIlNIOJAtRGaC4RdfEM1JLehdj7jUoCXb2jKe4UJW+/nhe6lK9W+j647k5Ja53/pLoXDBLb/Z+HCuhlpbjwfGPu4drijsM2YeqCe0heEQdoyX2fITWh9uuYew9o+VvfGncG8yM1mIPqJp1uZ/IQQ3gvchX+b1BKp+REzejNaIB8jAuGP8sxoK0iKQB8yKSmbsmSbT2y+9/AJRbXczCaQAA" />