Create a Job

Use this endpoint to create a job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supported Apps

Here are the list of apps that support this API.

Greenhouse (greenhouse)

Remarks:

Note: Only the first index on departments will be honored.

Oracle Cloud HCM (oracle-hcm-ats)

Remarks:

  • Supported fields: title, offices, recruiters, hiringManagers, numberOfOpenings, departments, compensation, onboardingDate, and metaData.recruitingType.
  • Required fields: title, hiringManagers, offices, recruiters, and metaData.recruitingType.
  • Use passthrough request to get the list of departments, list of locations for offices, list of currencies for compensation, and list of users for hiringManagers and recruiters.
  • RecruitingType possible values: ORA_CAMPUS, ORA_CONTINGENT, ORA_EXECUTIVES, ORA_HOURLY, and ORA_PROFESSIONAL.

Note: Only the first index of offices, recruiters, hiringManagers, department, and compensation will be honored.

Zoho Recruit (zoho-recruit)

Remarks:

  • Supported fields: title, departments, closingDate, description, offices, recruiters, hiringManagers, numberOfOpenings, compensation, employmentType, workMode, experience, requiredSkills, and metaData.industryName.
  • Required fields: title, departments, closingDate, and metaData.industryName.
  • Department object must contain name field.
  • Use passthrough request to get the list of users for recruiters and hiringManagers.

Note: Only the first index of departments, offices, recruiters, hiringManagers, and compensation will be honored.

Workday (workday-ats)

Remarks:

  • Supported fields: title, description, departments, offices, compensation, questions, employmentType, onboardingDate, closingDate, numberOfOpenings, educationLevel, requiredSkills, metaData.createJobRequisitionReasonReference, metaData.workerTypeReference, metaData.recruitingStartDate, metaData.jobProfileReference, and metaData.workerSubTypeReference.
  • Required fields: title, departments, offices, employmentType, onboardingDate, metaData.createJobRequisitionReasonReference, metaData.workerTypeReference, metaData.recruitingStartDate, metaData.jobProfileReference, and metaData.workerSubTypeReference.
  • Use passthrough request to get the list of location for offices, list of department, list of employment Type, list of education type for educationLevel, list of questionnaires for questions, list of reasons for metaData.createJobRequisitionReasonReference, list of job profiles for metaData.jobProfileReference, list of worker type for metaData.workerTypeReference, and list of worker sub-type for metaData.workerSubTypeReference,

Note: Only the first index of departments, offices, and questions will be honored.

TeamTailor (teamTailor)

Remarks:

Note: Only the first index of departments, recruiters, and compensation will be honored.

Breezy (breezy)

Remarks:

  • Supported fields: title, description, status, departments, offices, questions, employmentType, workMode, and educationLevel.
  • Required fields: title, description, and offices, and employmentType.
  • Use passthrough request to get the list of questionnaires for questions.
  • offices.country possible values: alpha2 country code.

Note: Only the first index of departments, offices, and questions will be honored.

Lever (lever)

Remarks:

  • Supported fields: title, description, status, departments, offices, hiringManagers, compensation, employmentType, workMode, experience, educationLevel, requiredSkills, and metaData.team.
  • Required fields: title, departments, offices, and metaData.team.
  • Use passthrough request to get the list of users for hiringManagers.
  • compensation.currency valid values: The three-character ISO 4217 Currency Code.
  • Guide to get the valid values for offices.name, employmentType, departments.name, and metaData.team.

Note: Only the first index of offices, departments, hiringManagers, and compensation will be honored.

Vincere (vincere)

Remarks: Only the recruiter and hiringManager at 0th index are honored in the given list. compensation -> only objects of type SALARY is honored. questions -> only title field is honored.

JobAdder (jobadder)
iCIMS (icims)

Remarks:

  • offices[0].officeId is a required field
  • hiringManagers[0].hiringManagerId is a required field
  • jobtitle, departments[0].departmentId and recruiters[0].recruiterId are honored fields.
JobDiva (jobdiva)

Remarks:

  • Only the first entry in offices, departments, and compensation is honored.
  • The requiredSkills field must follow the format: SKILL~alt~proficiency~recent~agentSearch. Multiple skills can be provided by separating each entry with a comma (,).
BambooHR ATS (bamboohr-ats)

Remarks:

Supported Fields:

  • title - required
  • description - required
  • status - required - allowed values : 'Draft' 'Open' 'On Hold' 'Filled' 'Canceled'
  • employmentType - required - e.g. Full-Time, Part-Time, Contractor, etc.
  • hiringManagers[0].hiringManagerId -> use hiringManagers[].employeeId that you obtained from read API or Job sync.
  • offices[0].officeId
  • departments[0].departmentId
UKG Pro Recruiting (ukgpro-ats)

Remarks:

  • metaData.language is a required field, Example values : 'en_us', 'en_gb', 'es_es', 'fr_ca', 'de_de', 'pt_br', 'zh_cn' etc.
  • metaData.jobCode is a required field

Supported Fields:

  • title - required
  • description
  • status - required - allowed values : 'Draft' 'Open' 'On Hold' 'Filled' 'Canceled'
  • employmentType - required - e.g. Full-Time, Part-Time, Contractor, etc.
  • hiringManagers[0].hiringManagerId
  • offices.officeId
  • compensation.maxAmount, compensation.currency only when compensation.type == "SALARY"
  • experience.minimumYears
  • experience.preferredYears
  • questions.title
  • questions.type
  • questions.options[].value
  • questions.isRequired
Recruitee (recruitee)

Remarks:

  • Supported Fields: title, description, requiredSkills, departments, offices, workMode, and metaData.
  • At least one office with officeId is required.
  • Use passthrough request to get the list of locations for offices.
Ashby (ashby)

Remarks:

Supported Fields:

  • title - required
  • offices[0].officeId - required
  • departments[0].departmentId - required
  • jobTemplateId
  • status
Pinpoint (pinpoint)

Remarks:

Supported Fields:

  • title - required

  • description - required

  • status

  • numberOfOpenings

  • employmentType

  • workMode

  • compensation

  • closingDate

  • requiredSkills

  • hiringManagers

  • recruiters

  • metaData.visibility - required

  • metaData.workflowId - required

  • metaData.keyResponsibilities - required

  • metaData.structureLinkId - required

Note:

Recruiterflow (recruiterflow)

Supported Request Fields:

  • title - Required
  • description - Required
  • employmentType - Required
  • departments - Required
  • offices - Required
  • requiredSkills
  • experience.minimumYears
  • experience.preferredYears
  • compensation

Additional Metadata:

  • companyId - Required
  • createdBy - Required

Supported Response Fields:

  • jobId

Note:

Recruit CRM ATS (recruit-crm-ats)

Supported Request Fields:

  • title - Required
  • description - Required
  • status - Required
  • offices - only the one at 0th index is honored
  • recruiters.recruiterId
  • compensation.minAmount
  • compensation.maxAmount
  • compensation.currency - expects currencyId, can be obtained using passthrough request
  • compensation.period - expects salary_type_id, can be obtained using passthrough request
  • questions.questionId
  • experience.minimumYears
  • experience.preferredYears
  • educationLevel - expects qualificationId, can be obtained using passthrough request
  • employmentType
  • workMode
  • requiredSkills - can give multiple skills , separated.
  • numberOfOpenings

Additional Metadata:

Supported Response Fields:

  • jobId
Loxo (loxo)

Supported Request Fields:

  • title
  • description
  • status
  • offices - only the one at 0th index is honored
  • offices[0].country - expects countryId, can be obtained using passthrough request
  • offices[0].state - expects stateId, can be obtained using passthrough request
  • hiringManagers.email
  • recruiters.email
  • compensation.minAmount
  • compensation.maxAmount
  • questions.questionId
  • employmentType - expects employmentTypeId, can be obtained using passthrough request
  • workMode

Supported Response Fields:

  • jobId
Jobvite (jobvite)

Supported Request Fields:

  • title - required
  • description - required
  • status
  • departments[0].name
  • offices[].officeId - multiple office ids are honored, but name, country, state are honored only in the object at 0th index
  • offices[0].name
  • offices[0].country
  • offices[0].state
  • hiringManagers.email - the email at 0th index is considered as a primary hiringmanagerEmail
  • recruiters.email - the email at 0th index is considered as a primary recruiterEmail
  • compensation.minAmount
  • compensation.maxAmount
  • compensation.currency
  • compensation.period
  • employmentType
  • workMode
  • numberOfOpenings
  • jobTemplateId

Supported Response Fields:

  • jobId
ERPNext ATS (erpnext-ats)

Body Params
string
required

Title of the job.

string

Description of the job.

string
enum

Status of the Job.

Allowed:
departments
array of objects

Departments to be associated with the job.

departments
offices
array of objects

Offices/locations to be associated with the job.

offices
hiringManagers
array of objects
hiringManagers
recruiters
array of objects
recruiters
compensation
array of objects
compensation
questions
array of objects
questions
string
enum
Allowed:
string
enum
Allowed:
experience
object
date-time
date-time
number
string
enum
string
string
string

JSON-formatted string containing set of key-value attributes to provide additional data

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json