{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/GetAtsJobsPositiveResponse",
"title": "GetAtsJobsPositiveResponse",
"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",
"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."
},
"job_code": {
"type": [
"string",
"null"
],
"description": "The human readable job code. Some systems expose this as the Requisition Code/ID."
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the job. This field is usually returned as HTML."
},
"confidential": {
"type": [
"boolean",
"null"
],
"description": "**(\u26a0\ufe0f Deprecated)** It makes more sense to store the visibility of a job in an enum. Therefore, we introduced the `visibility` enum on jobs."
},
"weekly_hours": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The number of hours per week an employee is expected to work."
},
"employment_type": {
"anyOf": [
{
"type": "string",
"enum": [
"FULL_TIME",
"PART_TIME",
"CONTRACT",
"SEASONAL",
"INTERNSHIP"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The type of employment contract. In rare cases where can't find a clear mapping, the original string is passed through."
},
"status": {
"anyOf": [
{
"type": "string",
"enum": [
"OPEN",
"CLOSED",
"DRAFT",
"ARCHIVED"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The job's current status.\n\n*Note: For any checks (e.g., \"can we publish this job?\"), always evaluate both `status` and `visibility`. For example, a job can be `status=OPEN` with `visibility=INTERNAL`, meaning only existing employees can apply.*\n\n In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
},
"visibility": {
"anyOf": [
{
"type": "string",
"enum": [
"PUBLIC",
"INTERNAL",
"UNLISTED",
"CONFIDENTIAL"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "Describes the visibility of the job:\n\n- `PUBLIC`: visible to everyone, published on a job board\n- `INTERNAL`: only visible to employees of the company itself\n- `UNLISTED`: anyone can apply but only if they have the link to it\n- `CONFIDENTIAL`: nobody can apply and it's only visible in the ATS to people who were invited to it\n\n*Note: For any checks (e.g., \"can we publish this job?\"), always evaluate both `status` and `visibility`.*\n\n In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
},
"category": {
"type": [
"string",
"null"
],
"description": "The category of the job (often the job industry). The original string is passed through, for example \"Information Technology\", \"Quality Assurance\", \"Marketing\"."
},
"department": {
"type": [
"string",
"null"
],
"description": "The internal department or team the job belongs to. The original string is passed through, for example \"IT/Operations\", \"Engineering - Platform\", \"Customer Success\"."
},
"post_url": {
"type": [
"string",
"null"
],
"description": "The public job posting URL of the ATS itself. This can be used by external job boards to redirect applicants."
},
"experience_level": {
"type": [
"string",
"null"
],
"description": "The role's seniority or experience level. The original string is passed through, for example \"Mid-Senior Level\", \"5+ years\", \"Associate\", \"IC3\"."
},
"remote_work_status": {
"anyOf": [
{
"type": "string",
"enum": [
"REMOTE",
"HYBRID",
"TEMPORARY",
"ON_SITE"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "Defines if the job supports remote work and if so, to what extent."
},
"salary_amount": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The salary amount in the given currency."
},
"salary_amount_from": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The lower bound of the salary range."
},
"salary_amount_to": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308,
"description": "The upper bound of the salary range."
},
"salary_currency": {
"type": [
"string",
"null"
],
"description": "Salary currency usually returned in [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html)."
},
"salary_period": {
"anyOf": [
{
"type": "string",
"enum": [
"YEAR",
"MONTH",
"TWO_WEEKS",
"WEEK",
"DAY",
"HOUR"
]
},
{
"type": "string",
"description": "If we can't find a clear mapping: The original string passed through."
},
{
"type": "null"
}
],
"description": "The period of time over which the salary amount is paid (not equal to the pay frequency). In rare cases where we can\u2019t find a clear mapping, the original string is passed through."
},
"location": {
"type": [
"object",
"null"
],
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
],
"description": "Contains the ISO2 country code if possible. If not, it contains the original value."
},
"raw": {
"type": [
"string",
"null"
],
"description": "If we have address data, this is filled with the raw address string."
},
"state": {
"type": [
"string",
"null"
]
},
"street_1": {
"type": [
"string",
"null"
],
"description": "If we can parse the address data, this field contains the first part of the street information."
},
"street_2": {
"type": [
"string",
"null"
]
},
"zip_code": {
"type": [
"string",
"null"
]
}
},
"description": "The location of the listed job."
},
"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 job posting in the source ATS system."
},
"opened_at": {
"description": "YYYY-MM-DDTHH:mm:ss.sssZ",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"closed_at": {
"description": "The date the job closed or is scheduled to close. A future value typically indicates the job remains open for applications until that date.\n\nPlease use the `status` and `visibility` fields to determine if a job can be published.",
"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"
}
},
"contact_id": {
"type": [
"string",
"null"
],
"description": "**(\u26a0\ufe0f Deprecated)** The user ID of the contact person for this job. We strongly recommend using the new `hiring_team` property instead as it provides more complete and accurate information about the ATS users connected to a job."
},
"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."
},
"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"
}
},
"stages": {
"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"
],
"description": "The application stage name. For example, \"Initial Screening\"."
},
"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."
},
"index": {
"type": [
"integer",
"null"
],
"format": "int64",
"description": "Numeric index following the order of the stages if they are ordered in the underlying tool."
}
},
"required": [
"id",
"remote_id",
"name",
"remote_data"
],
"examples": [
{
"id": "5J7L4b48wBfffYwek9Az9pkM",
"remote_id": "32",
"name": "Initial Screening",
"remote_data": null,
"index": 0
}
]
},
"description": "Application stages a candidate can be in for this particular job. "
},
"screening_questions": {
"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."
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
],
"description": "Additional instructions or context. Typically a short sentence, but sometimes a long detailed description (e.g., for EEO questions). May include HTML for extra formatting."
},
"format": {
"anyOf": [
{
"type": "object",
"properties": {
"display_type": {
"type": [
"string",
"null"
],
"enum": [
"SINGLE_LINE",
"MULTI_LINE",
"EMAIL",
"URL"
],
"description": "If unavailable, we recommend displaying a single-line input."
},
"max_length": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"type": {
"type": "string",
"const": "TEXT"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"display_type": {
"type": [
"string",
"null"
],
"enum": [
"SLIDER",
"FIELD"
],
"default": "FIELD"
},
"max": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308
},
"min": {
"type": [
"number",
"null"
],
"format": "double",
"minimum": -1.7976931348623157e+308
},
"type": {
"type": "string",
"const": "NUMBER"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"accepted_mime_types": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"max_file_size_bytes": {
"type": [
"integer",
"null"
],
"format": "int64"
},
"type": {
"type": "string",
"const": "FILE"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"display_type": {
"type": [
"string",
"null"
],
"enum": [
"DROPDOWN",
"RADIO"
]
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Kombo ID of this question option. Use this ID to specify the answer to this question."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "ID in the connected ATS. This might be null as some systems only use the name to identify the option."
},
"name": {
"type": "string",
"description": "Content of the question option."
}
},
"required": [
"id",
"name"
]
}
},
"type": {
"type": "string",
"const": "SINGLE_SELECT"
}
},
"required": [
"options",
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "BOOLEAN"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "DATE"
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Kombo ID of this question option. Use this ID to specify the answer to this question."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "ID in the connected ATS. This might be null as some systems only use the name to identify the option."
},
"name": {
"type": "string",
"description": "Content of the question option."
}
},
"required": [
"id",
"name"
]
}
},
"type": {
"type": "string",
"const": "MULTI_SELECT"
}
},
"required": [
"options",
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "INFORMATION",
"description": "This is just a text block."
}
},
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"raw_question": {
"description": "We pass the original question data along so you can handle it."
},
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kombo/refs/heads/main/json-schema/kombo-getatsjobspositiveresponse-schema.json