Jobs

The Job object is used to represent a Job offering at a company.

The Job object

Properties


idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

nameString
Optional
The job's name.

descriptionString
Optional
The job's description.

codeString
Optional
The job's code. Typically an additional identifier used to reference the particular job that is displayed on the ATS.

statusEnum
Optional
The job's status. Possible values include: OPEN, CLOSED, DRAFT, ARCHIVED, PENDING, or - in cases where there is no clear mapping - the original value passed through.

job_posting_urlsUrl[]
Required

The Url object

The Url object is used to represent a candidate's website.
JSON
{
"value": "http://alturl.com/p749b",
"url_type": "PERSONAL"
}

Properties


valueString
Optional
The site's url.

url_typeEnum
Optional
The type of site. Possible values include: PERSONAL, COMPANY, PORTFOLIO, BLOG, SOCIAL_MEDIA, OTHER, JOB_POSTING, or - in cases where there is no clear mapping - the original value passed through.

remote_created_atString
Optional
When the third party's job was created.

remote_updated_atString
Optional
When the third party's job was updated.

confidentialBoolean
Optional
Whether the job is confidential.

departmentsArray
Required
IDs of Department objects for this Job.

officesArray
Required
IDs of Office objects for this Job.

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

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

remote_dataRemoteData[]
Optional

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

The Job object
JSON
{
"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
"remote_id": "8765432",
"name": "Software Engineer (Merge is actually hiring btw)",
"description": "<b>If you're reading this documentation, you might be a good fit for Merge!</b>",
"code": "C0025",
"status": "OPEN",
"job_posting_urls": [
{
"value": "https://merge.dev/careers",
"url_type": "JOB_POSTING"
}
],
"remote_created_at": "2021-10-15T00:00:00Z",
"remote_updated_at": "2021-10-16T00:00:00Z",
"confidential": true,
"departments": [
"5b3c1341-a20f-4e51-b72c-f3830a16c97b",
"d6e687d6-0c36-48a1-8114-35324b5cb38f"
],
"offices": [
"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"
],
"hiring_managers": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"recruiters": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"remote_data": [
{
"path": "/positions",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}

GET

/jobs

Returns a list of Job objects.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


codeString
Optional
If provided, will only return jobs with this code.

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, will only return objects modified after this datetime.

modified_beforeString
Optional
If provided, will only return objects modified before this datetime.

page_sizeInteger
Optional
Number of results to return per page.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

remote_idString
Optional
The API provider's ID for the given object.

statusString
Optional
If provided, will only return jobs with this status. Options: ('OPEN', 'CLOSED', 'DRAFT', 'ARCHIVED', 'PENDING')

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
"remote_id": "8765432",
"name": "Software Engineer (Merge is actually hiring btw)",
"description": "<b>If you're reading this documentation, you might be a good fit for Merge!</b>",
"code": "C0025",
"status": "OPEN",
"job_posting_urls": [
{
"value": "https://merge.dev/careers",
"url_type": "JOB_POSTING"
}
],
"remote_created_at": "2021-10-15T00:00:00Z",
"remote_updated_at": "2021-10-16T00:00:00Z",
"confidential": true,
"departments": [
"5b3c1341-a20f-4e51-b72c-f3830a16c97b",
"d6e687d6-0c36-48a1-8114-35324b5cb38f"
],
"offices": [
"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"
],
"hiring_managers": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"recruiters": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"remote_data": [
{
"path": "/positions",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
]
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

EngageATS

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Greenhouse - Job Boards API

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Polymer

Polymer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

TalentReef

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

UKG Pro Recruiting

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET

/jobs/{id}

Returns a Job object with the given id.


Header Parameters


AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.

Query & Path Parameters


expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

remote_fieldsString
Optional
Which fields should be returned in non-normalized form.

Response
JSON
{
"id": "022a2bef-57e5-4def-8ed2-7c41bd9a5ed8",
"remote_id": "8765432",
"name": "Software Engineer (Merge is actually hiring btw)",
"description": "<b>If you're reading this documentation, you might be a good fit for Merge!</b>",
"code": "C0025",
"status": "OPEN",
"job_posting_urls": [
{
"value": "https://merge.dev/careers",
"url_type": "JOB_POSTING"
}
],
"remote_created_at": "2021-10-15T00:00:00Z",
"remote_updated_at": "2021-10-16T00:00:00Z",
"confidential": true,
"departments": [
"5b3c1341-a20f-4e51-b72c-f3830a16c97b",
"d6e687d6-0c36-48a1-8114-35324b5cb38f"
],
"offices": [
"9871b4a9-f5d2-4f3b-a66b-dfedbed42c46"
],
"hiring_managers": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"recruiters": [
"787ed912-33ec-444e-a215-8d71cc42fc12"
],
"remote_data": [
{
"path": "/positions",
"data": [
"Varies by platform"
]
}
],
"remote_was_deleted": true
}
Field support by platform

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Ashby

Ashby

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

BambooHR

BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

BizMerlinHR

BizMerlinHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_idString

remote_updated_atString

statusEnum

Breezy

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

CATS

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

Clockwork

Clockwork

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Comeet

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Cornerstone TalentLink

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

EngageATS

EngageATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Eploy

Eploy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Freshteam

Freshteam

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Greenhouse - Job Boards API

Greenhouse - Job Boards API

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

JazzHR

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum

JobScore

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Jobsoid

Jobsoid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


confidentialBoolean

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Lever

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Polymer

Polymer

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


nameString

remote_dataRemoteData[]

remote_idString

statusEnum

Sage HR

Sage HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

SAP SuccessFactors

SAP SuccessFactors

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

TalentReef

TalentReef

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

UKG Pro Recruiting

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

remote_updated_atString

statusEnum

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

descriptionString

nameString

remote_created_atString

remote_dataRemoteData[]

remote_idString

statusEnum

Workday

Workday

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


codeString

confidentialBoolean

descriptionString

nameString

remote_dataRemoteData[]

remote_idString

statusEnum
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.