Properties
| Name | Type | Description |
|---|---|---|
| status | string | |
| data | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetAtsApplicationsPositiveResponse",
"title": "GetAtsApplicationsPositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"next": {
"type": [
"string",
"null"
],
"description": "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."
},
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "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."
},
"outcome": {
"type": [
"string",
"null"
],
"enum": [
"PENDING",
"HIRED",
"DECLINED"
],
"description": "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`.\nKombo will always try to deliver this information as reliably as possible."
},
"rejection_reason_name": {
"type": [
"string",
"null"
],
"description": "Reason for the rejection of the candidate."
},
"rejected_at": {
"description": "The time that the application was rejected.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"current_stage_id": {
"type": [
"string",
"null"
],
"description": "ID of the current application stage"
},
"job_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the job which the candidate applied to. The ID can be used to retrieve the job from the `get jobs` endpoint."
},
"candidate_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the candidate who applied to the job. The ID can be used to retrieve the candidate from the `get candidates` endpoint."
},
"screening_question_answers": {
"type": [
"array",
"null"
],
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"content": {
"type": [
"string",
"null"
]
}
},
"required": [
"content"
]
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "TEXT"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"choice": {
"type": [
"string",
"null"
]
}
},
"required": [
"choice"
]
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "SINGLE_SELECT"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"choices": {
"type": "array",
"items": {
"type": "string"
},
"default": []
}
}
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "MULTI_SELECT"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"checked": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"checked"
]
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "BOOLEAN"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"number": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308
}
},
"required": [
"number"
]
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "NUMBER"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"date": {
"type": [
"string",
"null"
],
"format": "date-time",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$"
}
},
"required": [
"date"
]
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "DATE"
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
},
{
"type": "object",
"properties": {
"answer": {
"type": "object",
"properties": {
"raw": {
"type": "null",
"description": "We pass the original question data along so you can handle it."
}
}
},
"question": {
"type": "object",
"properties": {
"remote_id": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"const": "UNKNOWN",
"description": "When we're not able to map a specific question type yet, we will return this type. Every `UNKNOWN` question will also be parsed and unified by us at some point."
}
},
"required": [
"remote_id",
"title",
"type"
]
}
},
"required": [
"answer",
"question"
]
}
]
},
"default": [],
"description": "A list of answers to screening questions. The screening answer type `FILE` is currently unsupported."
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
},
"integration_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object."
},
"key": {
"type": "string",
"description": "The key of the field in the remote system."
},
"type": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
},
"value": {
"type": "null",
"description": "The field's value."
},
"label": {
"type": [
"string",
"null"
],
"description": "The label of the field. (not always available)"
}
},
"required": [
"id",
"key",
"type",
"label"
]
},
"description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
"examples": [
[
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
]
]
},
"remote_url": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL to the application in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated application URL is available, so you might need to fall back to the candidate URL."
},
"changed_at": {
"description": "The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the `updated_after` parameter which will return records when either the record itself OR its related models have been updated.",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_deleted_at": {
"description": "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.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_created_at": {
"description": "The date and time the object was created in the remote system.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_updated_at": {
"description": "A timestamp retrieved from the remote system, describing when the resource was last updated.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_data": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
},
"candidate": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "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."
},
"first_name": {
"type": [
"string",
"null"
],
"description": "First name of the candidate."
},
"last_name": {
"type": [
"string",
"null"
],
"description": "Last name of the candidate."
},
"email_addresses": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"email_address": {
"type": [
"string",
"null"
],
"pattern": "^(?!\\.)(?!.*\\.\\.)([\\w'+-.]*)[\\w+-]@([\\da-z][\\da-z-]*\\.)+[a-z]{2,}$"
},
"type": {
"type": [
"string",
"null"
],
"description": "Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`."
}
},
"required": [
"type"
]
},
"default": [],
"description": "A list of email addresses of the candidate with an optional type. If an email address is invalid, it will be filtered out."
},
"phone_numbers": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"phone_number": {
"type": "string"
},
"type": {
"type": [
"string",
"null"
],
"description": "Kombo exposes type information through this field. If we don't get any information from the tool, we will set this to `null`."
}
},
"required": [
"phone_number"
]
},
"default": [],
"description": "A list of phone numbers of the candidate."
},
"social_media": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"link": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"username": {
"type": [
"string",
"null"
]
}
}
},
"default": [],
"description": "List of social media accounts of the candidate."
},
"source": {
"type": [
"string",
"null"
],
"description": "The hiring source of the candidate. If you're a job board or recruiting service, you can use this to validate which candidates applied through your service and ensure that the correct referral compensation is paid out."
},
"remote_url": {
"type": [
"string",
"null"
],
"format": "uri",
"description": "URL to the candidate profile in the source ATS system. When embedding this in your system, please consider that not for all ATS a dedicated candidate profile URL is available, so you might need to fall back to the application URL."
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "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."
},
"name": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"remote_id",
"name"
],
"examples": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "32",
"name": "High Potential"
}
]
}
}
},
"required": [
"id",
"remote_id",
"first_name",
"last_name",
"source",
"remote_url",
"tags"
]
},
"current_stage": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "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."
},
"name": {
"type": [
"string",
"null"
],
"description": "The application stage name. For example, \"Initial Screening\"."
},
"index": {
"type": [
"integer",
"null"
],
"format": "int64",
"examples": [
2
]
}
},
"required": [
"id",
"remote_id",
"name",
"index"
]
},
"job": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "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."
},
"name": {
"type": [
"string",
"null"
],
"description": "Title of the job."
}
},
"required": [
"id",
"remote_id",
"name"
],
"examples": [
{
"id": "H5daSm8e85Dmvmne3wLeCPhX",
"remote_id": "32",
"name": "Backend Engineer"
}
]
},
"interviews": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "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 sy
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kombo/refs/heads/main/json-schema/kombo-getatsapplicationspositiveresponse-schema.json