Sign in

v1

latestOpenAPI 3.1.02026-07-14801408.6 KB

/requisitions

Returns a collection of your account requisitions. Required scope: r_requisitions. Accessible with all token types for accounts with Hiring Plan.

get/requisitions

Query parameters

statestring

Returns requisitions with the current state. Possible values (processing, draft, pending, approved, open, filled, rejected, cancelled, reserved, on_hold).

job_idstring

Returns requisitions for the job with the specified ID.

plan_date_fromstring

Returns requisitions with plan date after the specified month. Format is YYYY-MM (example: 2022-01).

plan_date_tostring

Returns requisitions with plan date before the specified month. Format is YYYY-MM (example: 2022-12).

limitinteger

Specifies the number of requisitions to try and retrieve per page (optional)

since_idstring

Returns results with an ID greater than or equal to the specified ID. (optional)

max_idstring

Returns results with an ID less than or equal to the specified ID. (optional)

created_afterstring date-time

Returns results created after the specified timestamp. (optional)

updated_afterstring date-time

Returns results updated after the specified timestamp.

Response

200

Example response

{
  "requisitions": [
    {
      "id": "16d60890",
      "code": "REQ101",
      "job": {
        "id": "23c47225",
        "title": "Pilot"
      },
      "department": {
        "id": "1ee2e1d2",
        "name": "Flight"
      },
      "location": {
        "location_str": "California, USA",
        "country": "United States",
        "country_code": "US",
        "region": "California",
        "region_code": "CA"
      },
      "hiring_manager": {
        "id": "31169ee",
        "name": "Jack Shephard"
      },
      "owner": {
        "id": "2310f579",
        "name": "John Locke"
      },
      "plan_date": "2022-12-31",
      "salary_range": {
        "from": 60000,
        "to": 80000,
        "frequency": "year",
        "currency": "EUR"
      },
      "employment_type": "Full-time",
      "reason": "replacement",
      "state": "pending",
      "requisition_attributes": [
        {
          "name": "Level",
          "value": {
            "body": "Senior"
          }
        }
      ],
      "approval_groups": [
        {
          "id": "129cf872",
          "approvers": [
            {
              "id": "15046d4c",
              "name": "Kate Austen",
              "decision": "approved"
            }
          ]
        }
      ]
    }
  ]
}