Sign in

v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Job API:Jobs

Add a job

post/jobs

Request body

jobTitlestring nullable required
companyIdinteger nullable
contactIdinteger nullable
jobDescriptionstring nullable
statusIdinteger nullable

Job status

userFavouriteboolean nullable

Job is a favourite for the current user

workplaceAddressIdstring uuid nullable

Workplace Address Id

workTypeIdinteger nullable
numberOfJobsinteger
sourcestring nullable
ownerUserIdinteger

User Id - Owner of this job

recruiterUserIdinteger[] nullable

User Id - Optional list of recruiters assigned to the job

workflowIdinteger nullable
endDatestring date nullable

The specific date that the job end

Example request

{
  "custom": [
    {
      "fieldId": 1,
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "value": [
        "List value 1",
        "List value 2"
      ]
    },
    {
      "fieldId": 3,
      "value": "2018-07-01"
    }
  ]
}

Response

Created

jobIdinteger required
jobTitlestring nullable
sourcestring nullable
userFavouriteboolean nullable
jobDescriptionstring nullable
numberOfJobsinteger
endDatestring date nullable
jobTypestring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable
closedAtstring date-time nullable
requisitionIdinteger nullable

Example response

{
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}