KOkombo
Unified ATS (Assessment & Background Check) API

Get orders

Changed on

Get all assessment and background check orders of an integration.

get/assessment/orders

Request

Query parameters

cursorstring

An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.

page_sizeinteger

The number of results to return per page. Maximum is 250.

idsstring

Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.

statusesstring

Filter by a comma-separated list of OPEN, COMPLETED, CANCELLED, REJECTED.

Leave this blank to get results matching all values.

created_afterstring date-time

Filter orders by their creation date-timestamp in the format: YYYY-MM-DDTHH:mm:ss.sssZ. Only orders created on or after this date-timestamp will be returned.

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Response

GET /assessment/orders Positive response

status'success' required

Example response

{
  "data": {
    "results": [
      {
        "id": "B5KQKhAgTv6ZwzrfAbqbhipd",
        "package_id": "typescript_test",
        "status": "OPEN",
        "candidate": {
          "remote_id": "12345",
          "email": "john.doe@gmail.com",
          "first_name": "John",
          "last_name": "Doe",
          "phone": "+1 123 456 7890"
        },
        "application": {
          "remote_id": "54321"
        },
        "job": {
          "remote_id": "67890",
          "name": "Bottle Opener",
          "job_code": "BO-2024-01",
          "description": "<p>We are looking for a skilled and energetic individual to join our team as the chief bottle open officer. This unique role requires precision, attention to detail, and the ability to handle a high volume of beverage bottles in a fast-paced environment. The ideal candidate will ensure bottles are opened swiftly and safely while maintaining hygiene standards.</p>",
          "location": {
            "street_1": "Lohmühlenstraße 65",
            "street_2": null,
            "city": "Berlin",
            "state": "Berlin",
            "zip_code": "12435",
            "country": "DE",
            "raw": "Berlin, Germany"
          },
          "hiring_team": [
            {
              "remote_id": "78901",
              "email": "jane.doe@gmail.com",
              "first_name": "Jane",
              "last_name": "Doe",
              "hiring_team_roles": [
                "RECRUITER"
              ]
            }
          ]
        }
      }
    ]
  }
}

Changes