Get interviews
Retrieve all interviews.
{
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00.000Z",
"ending_at": "2023-06-26T15:30:00.000Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"application_id": "H77fDF8uvEzGNPRubiz5DvQ7",
"stage_id": "H5daSm8e85Dmvmne3wLeCPhX",
"canceled": false,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"users": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev"
}
],
"application": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": "Any text string",
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
]
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer"
}
}
}
]
}
}This feature is currently available for the following integrations:
Workday
SAP SuccessFactors
SmartRecruiters
Lever
Recruitee
Greenhouse
Ashby
Pinpoint
Zoho Recruit
Breezy HR
Kombo Sandbox
You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
Top level filters use AND, while individual filters use OR if they accept multiple arguments. That means filters will be resolved like this: (id IN ids) AND (remote_id IN remote_ids)
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.
The number of results to return per page. Maximum is 250.
1 < x < 250Filter the entries based on the modification date in format YYYY-MM-DDTHH:mm:ss.sssZ. If you want to track entry deletion, also set the include_deleted=true query parameter, because otherwise, deleted entries will be hidden.
By default, deleted entries are not returned. Use the include_deleted query param to include deleted entries too.
true, false Filter by a comma-separated list of IDs such as 222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3.
Filter by a comma-separated list of remote IDs.
Response
Cursor string that can be passed to the cursor query parameter to get the next page. If this is null, then there are no more pages.
A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out.
First name of the candidate.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
Last name of the candidate.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
Title of the job.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
Parsed status of the application. If Kombo identifies that the application was accepted and the candidate hired, it will be HIRED. If the application was rejected or the candidate declined, it will be DECLINED. If the application is still in process, it will be PENDING.
Kombo will always try to deliver this information as reliably as possible.
PENDING, HIRED, DECLINED Reason for the rejection of the candidate.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
The Kombo ID of the application this interview belongs to. The ID can be used to retrieve the application from the get applications endpoint.
Whether the interview was canceled or not. If we have no information, this field will be null.
The timestamp when this object was last changed. This value is tracked by Kombo based on changes in the data.
The end time of the interview.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
The date and time the object was created in the remote system.
Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.
Remote data always has the endpoint path that we got the data from as the
top level key. For example, it could look like: { "/companies": { ... }}
This is not available on all plans. Reach out to Kombo if you need it.
The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
A timestamp retrieved from the remote system, describing when the resource was last updated.
If a system specifies to which stage this interview belongs to, this field will be the Kombo ID of the application stage. The ID can be used to retrieve the stage from the get application stages endpoint.
The start time of the interview.
The title of the interview.
Email of the user. If the email address is invalid, it will be set to null.
First name of the user.
The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.
Last name of the user.
The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.
Location of the interview.
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.
success {
"status": "success",
"data": {
"next": "eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0=",
"results": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"title": "Interview with John Doe",
"starting_at": "2023-06-26T14:30:00.000Z",
"ending_at": "2023-06-26T15:30:00.000Z",
"location": {
"city": "Berlin",
"country": "DE",
"raw": "Berlin, Germany",
"state": "Berlin",
"street_1": "Lohmühlenstraße 65",
"street_2": null,
"zip_code": "12435"
},
"application_id": "H77fDF8uvEzGNPRubiz5DvQ7",
"stage_id": "H5daSm8e85Dmvmne3wLeCPhX",
"canceled": false,
"remote_created_at": "2022-08-07T14:01:29.196Z",
"remote_updated_at": "2022-08-07T14:01:29.196Z",
"remote_data": null,
"changed_at": "2022-08-07T14:01:29.196Z",
"remote_deleted_at": null,
"users": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@kombo.dev"
}
],
"application": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"outcome": "HIRED",
"rejection_reason_name": "Any text string",
"candidate": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"first_name": "John",
"last_name": "Doe",
"email_addresses": [
{
"email_address": "john.doe@example.com",
"type": "PRIVATE"
}
]
},
"job": {
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "Backend Engineer"
}
}
}
]
}
}