Skip to main content
GET
/
assessment
/
orders
TypeScript
import { Kombo } from "@kombo-api/sdk";

const kombo = new Kombo({
  integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28",
  api_key: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await kombo.assessment.getAssessmentOrders({});

  for await (const page of result) {
    console.log(page);
  }
}

run();
{
  "status": "<string>",
  "data": {
    "next": "<string>",
    "results": [
      {
        "id": "<string>",
        "package_id": "<string>",
        "status": "OPEN",
        "candidate": {
          "remote_id": "<string>",
          "email": "jsmith@example.com",
          "first_name": "<string>",
          "last_name": "<string>",
          "phone": "<string>"
        },
        "application": {
          "remote_id": "<string>"
        },
        "job": {
          "remote_id": "<string>",
          "name": "<string>",
          "job_code": "<string>",
          "description": "<string>",
          "location": {
            "street_1": "<string>",
            "street_2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "zip_code": "<string>",
            "country": "<string>",
            "raw": "<string>"
          },
          "hiring_team": [
            {
              "remote_id": "<string>",
              "email": "<string>",
              "first_name": "<string>",
              "last_name": "<string>",
              "hiring_team_roles": [
                "RECRUITER"
              ]
            }
          ]
        }
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Query Parameters

​
cursor
string

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

​
page_size
integer<int64>
default:100

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

Required range: 1 <= x <= 250
​
ids
string

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

​
statuses
string

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

Leave this blank to get results matching all values.

​
created_after
string<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.

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$

Response

GET /assessment/orders Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required