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 Job object
          • GET/jobs
          • GET/jobs/{id}
          • GET/jobs/{job_id}/screening-questions
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsJobs

/jobs/{id}

GET
/ats/v1/jobs/:id
GET
/api/ats/v1/jobs/:id
$curl -G https://api.merge.dev/api/ats/v1/jobs/id \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>" \
>     --data-urlencode expand=departments,offices,hiring_managers,job_postings,recruiters \
>     -d remote_fields=status \
>     -d show_enum_origins=status
200Retrieved
1{
2  "id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
3  "remote_id": "8765432",
4  "created_at": "2021-09-15T00:00:00Z",
5  "modified_at": "2021-10-16T00:00:00Z",
6  "name": "Software Engineer (Merge is actually hiring btw)",
7  "description": "<b>If you're reading this documentation, you might be a good fit for Merge!</b>",
8  "code": "C0025",
9  "status": "OPEN",
10  "type": "POSTING",
11  "job_postings": [
12    "2r3c1341-a20f-4e51-b72c-f3830a16c97b",
13    "543ed912-33ec-444e-a215-8d71cc42fc12"
14  ],
15  "job_posting_urls": [
16    {
17      "value": "https://merge.dev/careers",
18      "url_type": "JOB_POSTING"
19    }
20  ],
21  "remote_created_at": "2021-10-15T00:00:00Z",
22  "remote_updated_at": "2021-10-16T00:00:00Z",
23  "confidential": true,
24  "departments": [
25    "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
26    "d6e687d6-0c36-48a1-8114-35324b5cb38f"
27  ],
28  "offices": [
29    "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"
30  ],
31  "hiring_managers": [
32    "787ed912-33ec-444e-a215-8d71cc42fc12"
33  ],
34  "recruiters": [
35    "787ed912-33ec-444e-a215-8d71cc42fc12"
36  ],
37  "remote_was_deleted": true,
38  "field_mappings": {
39    "organization_defined_targets": {
40      "custom_key": "custom_value"
41    },
42    "linked_account_defined_targets": {
43      "custom_key": "custom_value"
44    }
45  },
46  "remote_data": [
47    {
48      "path": "/positions",
49      "data": null
50    }
51  ]
52}

Returns a Job object with the given id.

Field support by integration

See all supported fields

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

Was this page helpful?
Previous

/jobs

Next

/jobs/{job_id}/screening-questions

Built with

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.
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

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.
namestring or null
The job's name.
descriptionstring or null
The job's description.
codestring or null
The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS.
statusenum or null

The job’s status.

  • OPEN - OPEN
  • CLOSED - CLOSED
  • DRAFT - DRAFT
  • ARCHIVED - ARCHIVED
  • PENDING - PENDING
Allowed values:
typeenum or null

The job’s type.

  • POSTING - POSTING
  • REQUISITION - REQUISITION
  • PROFILE - PROFILE
Allowed values:
job_postingslist of strings

IDs of JobPosting objects that serve as job postings for this Job.

job_posting_urlslist of objects
remote_created_atdatetime or null
When the third party's job was created.
remote_updated_atdatetime or null
When the third party's job was updated.
confidentialboolean or null
Whether the job is confidential.
departmentslist of strings

IDs of Department objects for this Job.

officeslist of strings

IDs of Office objects for this Job.

hiring_managerslist of strings

IDs of RemoteUser objects that serve as hiring managers for this Job.

recruiterslist of strings

IDs of RemoteUser objects that serve as recruiters for this Job.

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

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