General
Features
Guides
ATS Assessment API Reference
General API Reference
from kombo import Kombo
with Kombo(
integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.assessment.get_open_orders(page_size=100)
while res is not None:
# Handle items
res = res.next(){
"status": "<string>",
"data": {
"next": "<string>",
"results": [
{
"id": "<string>",
"package_id": "<string>",
"candidate": {
"email": "[email protected]",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"application": {
"remote_id": "<string>"
},
"job": {
"hiring_team": [
{
"remote_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"hiring_team_roles": [
"RECRUITER"
]
}
],
"remote_id": "<string>",
"name": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"raw": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>",
"zip_code": "<string>"
}
}
}
]
}
}Get open orders
Get all open assessment and background check orders of an integration.
from kombo import Kombo
with Kombo(
integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28",
api_key="<YOUR_BEARER_TOKEN_HERE>",
) as k_client:
res = k_client.assessment.get_open_orders(page_size=100)
while res is not None:
# Handle items
res = res.next(){
"status": "<string>",
"data": {
"next": "<string>",
"results": [
{
"id": "<string>",
"package_id": "<string>",
"candidate": {
"email": "[email protected]",
"remote_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"application": {
"remote_id": "<string>"
},
"job": {
"hiring_team": [
{
"remote_id": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"hiring_team_roles": [
"RECRUITER"
]
}
],
"remote_id": "<string>",
"name": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"raw": "<string>",
"state": "<string>",
"street_1": "<string>",
"street_2": "<string>",
"zip_code": "<string>"
}
}
}
]
}
}Authorizations
Headers
ID of the integration you want to interact with.
Query Parameters
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
An optional cursor string used for pagination. This can be retrieved from the next property of the previous page response.
The number of results to return per page. Maximum is 250. The number of results to return per page. Maximum is 250.
1 <= x <= 250Response
GET /assessment/orders/open Positive response
"success"Show child attributes
Show child attributes
Show child attributes
Show child attributes
The unique identifier of the assessment order.
The identifier of the assessment package.
Information about the candidate taking the assessment.
Show child attributes
Show child attributes
The candidate's email address.
The candidate's identifier in the integrated system.
The candidate's first name.
The candidate's last name.
The candidate's phone number.
Information about the job posting.
Show child attributes
Show child attributes
The hiring team allows you to sync users into your system who can access the job and its applications.
Show child attributes
Show child attributes
The team member's identifier in the integrated system.
The team member's email address.
The team member's first name.
The team member's last name.
Array of the roles of the user for this specific job. Currently only RECRUITER and HIRING_MANAGER are mapped into our unified schema.
RECRUITER, HIRING_MANAGER The job's identifier in the integrated system.
The job title.
The job location information.
Show child attributes
Show child attributes
Contains the ISO2 country code if possible. If not, it contains the original value.
If we have address data, this is filled with the raw address string.
If we can parse the address data, this field contains the first part of the street information.
Was this page helpful?