v1

latestOpenAPI 3.0.12026-08-063985821.3 MB

Requisition API:Requisitions

Add a requisition

post/requisitions

Request body

contactIdinteger required

Hiring manager (contact) submitting the requisition.

jobTitlestring nullable required

jobDescriptionstring nullable

workplaceAddressIdstring uuid nullable

Workplace address Id

workTypeIdinteger nullable

numberOfJobsinteger

sourcestring nullable

workflowIdinteger nullable

recruiterUserIdinteger[] nullable

User Id - Optional list of recruiters assigned to the requisition.

formIDinteger nullable

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

requisitionIdinteger required

status'Draft' | 'Submitted' | 'Rejected' | 'Approved' | 'Closed' string

workflowStageIndexinteger nullable

jobTitlestring required

jobOrderIdinteger nullable

createdAtstring date-time nullable

updatedAtstring date-time nullable

jobDescriptionstring nullable

numberOfJobsinteger

sourcestring nullable

Source of the requisition, or reason the requisition is being raised.

formIDinteger 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"
    }
  ]
}