For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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.
Allowed values:
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)
Allowed values:
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.
namestring or nullOptional
The job's name.
descriptionstring or nullOptional
The job's description.
codestring or nullOptional
The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS.
statusenum or nullOptional
The job's status.
Allowed values:
typeenum or nullOptional
The job's type.
Allowed values:
job_postingslist of stringsOptional
IDs of JobPosting objects that serve as job postings for this Job.
job_posting_urlslist of objectsOptional
remote_created_atdatetime or nullOptional
When the third party's job was created.
remote_updated_atdatetime or nullOptional
When the third party's job was updated.
confidentialboolean or nullOptional
Whether the job is confidential.
departmentslist of stringsOptional
IDs of Department objects for this Job.
officeslist of stringsOptional
IDs of Office objects for this Job.
hiring_managerslist of stringsOptional
IDs of RemoteUser objects that serve as hiring managers for this Job.
recruiterslist of stringsOptional
IDs of RemoteUser objects that serve as recruiters for this Job.
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
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
