> ## Documentation Index > Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get applications > Retrieve all applications. This feature is currently available for the following integrations: You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. Visit our in-depth guides to learn more about: * 💡 [Being aware of which applications are tracked](/ats/features/implementation-guide/tracking-created-applications#be-aware-of-which-applications-are-tracked) * 🚦 [Hiring signals](/ats/features/implementation-guide/tracking-created-applications#hiring-signals) * 📈 [Application stage changes](/ats/features/implementation-guide/tracking-created-applications#application-stage-changes) * ❓ [ATS-specific limitations](/ats/features/implementation-guide/tracking-created-applications#ats-specific-limitations) 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)` ## OpenAPI ````yaml GET /ats/applications openapi: 3.1.0 info: title: Kombo API version: 1.0.0 servers: - url: https://api.kombo.dev/v1 description: Kombo EU API - url: https://api.us.kombo.dev/v1 description: Kombo US API security: - ApiKey: [] tags: - name: General - name: Kombo Connect description: >- Endpoints for Kombo Connect, our end-user-facing flow for setting up new integrations. - name: Unified HRIS API description: Unified endpoints to access all the HR concepts you might need. - name: Unified ATS API description: Unified endpoints to access all the ATS concepts you might need. - name: Unified ATS (Assessment & Background Check) API description: >- Unified endpoints to operate Assessments and Background Checks for many applicant tracking systems. - name: Unified LMS API description: Unified endpoints to access all the LMS concepts you might need. - name: AI Apply description: Endpoints for AI-powered job application features. - name: Custom Endpoints description: Custom integration-specific endpoints. paths: /ats/applications: get: tags: - Unified ATS API summary: Get applications description: >- Retrieve all applications. This feature is currently available for the following integrations: You'd like to see this feature for another integration? Please reach out! We're always happy to discuss extending our coverage. Visit our in-depth guides to learn more about: - 💡 [Being aware of which applications are tracked](/ats/features/implementation-guide/tracking-created-applications#be-aware-of-which-applications-are-tracked) - 🚦 [Hiring signals](/ats/features/implementation-guide/tracking-created-applications#hiring-signals) - 📈 [Application stage changes](/ats/features/implementation-guide/tracking-created-applications#application-stage-changes) - ❓ [ATS-specific limitations](/ats/features/implementation-guide/tracking-created-applications#ats-specific-limitations) 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)` operationId: GetAtsApplications parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: join:HWUTwvyx2wLoSUHphiWVrp28 required: true - name: cursor in: query required: false description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterCursor' - name: page_size in: query required: false description: The number of results to return per page. Maximum is 250. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterPageSize' - name: updated_after in: query required: false description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | | `current_stage` | n/a | ✓ Yes | | `job` | ✗ No | ✗ No | | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ schema: $ref: '#/components/schemas/GetAtsApplicationsParameterUpdatedAfter' - name: include_deleted in: query required: false description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterIncludeDeleted' - name: ignore_unsupported_filters in: query required: false description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. schema: $ref: >- #/components/schemas/GetAtsApplicationsParameterIgnoreUnsupportedFilters - name: ids in: query required: false description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterIds' - name: remote_ids in: query required: false description: Filter by a comma-separated list of remote IDs. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterRemoteIds' - name: outcome in: query required: false description: >- **(⚠️ Deprecated - Use the `outcomes` filter instead.)** Filter applications by outcome. This allows you to get applications that are for example `PENDING`, `HIRED`, or `DECLINED`. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterOutcome' deprecated: true - name: outcomes in: query required: false description: |- Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED` * `PENDING`: The application is still being processed. * `HIRED`: The candidate was hired. * `DECLINED`: The candidate was declined. Leave this blank to get results matching all values. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterOutcomes' - name: job_ids in: query required: false description: >- Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterJobIds' - name: job_remote_ids in: query required: false description: >- Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterJobRemoteIds' - name: current_stage_ids in: query required: false description: >- Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterCurrentStageIds' - name: remote_created_after in: query required: false description: >- Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. schema: $ref: '#/components/schemas/GetAtsApplicationsParameterRemoteCreatedAfter' responses: '200': description: GET /ats/applications Positive response content: application/json: schema: $ref: '#/components/schemas/GetAtsApplicationsPositiveResponse' examples: example1: value: status: success data: next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: H77fDF8uvEzGNPRubiz5DvQ7 remote_id: '32' outcome: HIRED rejection_reason_name: null rejected_at: null current_stage_id: 5J7L4b48wBfffYwek9Az9pkM job_id: H5daSm8e85Dmvmne3wLeCPhX candidate_id: 26vafvWSRmbhNcxJYqjCzuJg screening_question_answers: - answer: choice: TypeScript question: remote_id: 48b4d36a-1d4b-4c50-ada7-9519078e65b4 title: Which is your primary programming language type: SINGLE_SELECT custom_fields: {} integration_fields: [] remote_url: https://app.greenhouse.io/applications/32 changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_created_at: '2022-08-07T14:01:29.196Z' remote_updated_at: '2022-08-07T14:01:29.196Z' remote_data: null candidate: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe email_addresses: - email_address: john.doe@example.com type: PRIVATE phone_numbers: - phone_number: +1-541-754-3010 type: HOME social_media: - link: https://www.youtube.com/watch?v=dQw4w9WgXcQ type: YOUTUBE username: null source: Employee Referral remote_url: https://app.greenhouse.io/people/32 tags: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' name: High Potential current_stage: id: 5J7L4b48wBfffYwek9Az9pkM remote_id: '32' name: Initial Screening index: 2 job: id: H5daSm8e85Dmvmne3wLeCPhX remote_id: '32' name: Backend Engineer interviews: - 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' canceled: false offers: - id: 76bab8LKuFtqpZ89mofCPMHX remote_id: '6' status: ACCEPTED default: $ref: '#/components/responses/ErrorResponseATS' x-codeSamples: - lang: python label: GetAtsApplications source: |- from kombo import Kombo with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.ats.get_applications(page_size=100, include_deleted=False, ignore_unsupported_filters=False) while res is not None: # Handle items res = res.next() - lang: typescript label: GetAtsApplications source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.ats.getApplications({}); for await (const page of result) { console.log(page); } } run(); - lang: ruby label: GetAtsApplications source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.ats.get_applications(page_size: 100, include_deleted: false, ignore_unsupported_filters: false) unless res.get_ats_applications_positive_response.nil? # handle response end components: schemas: GetAtsApplicationsParameterCursor: type: string description: >- An optional cursor string used for pagination. This can be retrieved from the `next` property of the previous page response. GetAtsApplicationsParameterPageSize: type: integer format: int64 minimum: 1 maximum: 250 default: 100 description: The number of results to return per page. Maximum is 250. GetAtsApplicationsParameterUpdatedAfter: description: >- Filter the entries based on the modification date in format `YYYY-MM-DDTHH:mm:ss.sssZ`. Returns records where either the record itself **OR** its nested data has been updated since this timestamp, even if the record's own `changed_at` field remains unchanged. If you want to track entry deletion, also set the `include_deleted=true` query parameter, because otherwise, deleted entries will be hidden. For more details, see [Understanding changed_at vs updated_after Behavior](https://docs.kombo.dev/ats/getting-started/fetching-data#understanding-changed_at-vs-updated_after-behavior). For this endpoint, `updated_after` matches when the returned record changed, or when related data changed as described below. | Path | Added/Removed | Linked Record | | --- | --- | --- | | `candidate` | n/a | ✓ Yes | | `candidate` → `tags` | ✗ No | ✗ No | | `current_stage` | n/a | ✓ Yes | | `job` | ✗ No | ✗ No | | `interviews` | ✓ Yes | ✓ Yes | | `offers` | ✓ Yes | ✓ Yes | _**Added/Removed**: Whether adding or removing entries from this list triggers an update (n/a for single records). **Linked Record**: Whether changes to the linked record itself trigger an update._ type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString GetAtsApplicationsParameterIncludeDeleted: type: string enum: - 'true' - 'false' default: 'false' description: >- By default, deleted entries are not returned. Use the `include_deleted` query param to include deleted entries too. GetAtsApplicationsParameterIgnoreUnsupportedFilters: type: string enum: - 'true' - 'false' default: 'false' description: >- When set to `true`, filters targeting fields not supported by this integration will be ignored instead of filtering out all results. GetAtsApplicationsParameterIds: type: string description: >- Filter by a comma-separated list of IDs such as `222k7eCGyUdgt2JWZDNnkDs3,B5DVmypWENfU6eMe6gYDyJG3`. GetAtsApplicationsParameterRemoteIds: type: string description: Filter by a comma-separated list of remote IDs. GetAtsApplicationsParameterOutcome: type: string enum: - PENDING - HIRED - DECLINED description: >- **(⚠️ Deprecated - Use the `outcomes` filter instead.)** Filter applications by outcome. This allows you to get applications that are for example `PENDING`, `HIRED`, or `DECLINED`. deprecated: true GetAtsApplicationsParameterOutcomes: type: string description: |- Filter by a comma-separated list of `PENDING`, `HIRED`, `DECLINED` * `PENDING`: The application is still being processed. * `HIRED`: The candidate was hired. * `DECLINED`: The candidate was declined. Leave this blank to get results matching all values. GetAtsApplicationsParameterJobIds: type: string description: >- Filter by a comma-separated list of job IDs. We will only return applications that are related to _any_ of the jobs. GetAtsApplicationsParameterJobRemoteIds: type: string description: >- Filter by a comma-separated list of job remote IDs. We will only return applications that are related to _any_ of the jobs. GetAtsApplicationsParameterCurrentStageIds: type: string description: >- Filter by a comma-separated list of application stage IDs. We will only return applications that are currently in _any_ of the stages. GetAtsApplicationsParameterRemoteCreatedAfter: description: >- Filter applications by the day they were created in the remote system. This allows you to get applications that were created on or after a certain day. type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString 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`. Kombo 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. - `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. 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. 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 system doesn't provide a clear primary key. title: type: - string - 'null' description: The title of the interview. starting_at: description: The start time of the interview. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString ending_at: description: The end time of the interview. type: - string - 'null' format: date-time externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString 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: Location of the interview. canceled: type: - boolean - 'null' description: >- Whether the interview was canceled or not. If we have no information, this field will be `null`. required: - id - remote_id - title - starting_at - ending_at - canceled examples: - 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' canceled: false offers: 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. status: type: - string - 'null' enum: - ACCEPTED - DECLINED - SENT - APPROVED - DRAFT - ABANDONED description: > The offer’s current status. The usual flow of statuses is as follows: `DRAFT` -> `APPROVED` -> `SENT` -> `ACCEPTED` or `DECLINED`. Please note that not all systems will expose all statuses. For example, most systems do not include the `APPROVED` status - `ACCEPTED`: The offer was accepted by the candidate. - `DECLINED`: The offer was declined by the candidate. - `SENT`: The offer was sent to the candidate. - `APPROVED`: The draft was approved. - `DRAFT`: The offer is a draft and has not yet been sent to the candidate. - `ABANDONED`: The offer has expired or is no longer valid and should not be considered. required: - id - remote_id - status examples: - id: 76bab8LKuFtqpZ89mofCPMHX remote_id: '6' status: ACCEPTED required: - id - remote_id - outcome - rejection_reason_name - rejected_at - current_stage_id - job_id - candidate_id - custom_fields - integration_fields - remote_url - changed_at - remote_deleted_at - remote_created_at - remote_updated_at - remote_data - candidate - current_stage - job - interviews - offers required: - next - results examples: - next: >- eyJwYWdlIjoxMiwibm90ZSI6InRoaXMgaXMganVzdCBhbiBleGFtcGxlIGFuZCBub3QgcmVwcmVzZW50YXRpdmUgZm9yIGEgcmVhbCBjdXJzb3IhIn0= results: - id: H77fDF8uvEzGNPRubiz5DvQ7 remote_id: '32' outcome: HIRED rejection_reason_name: null rejected_at: null current_stage_id: 5J7L4b48wBfffYwek9Az9pkM job_id: H5daSm8e85Dmvmne3wLeCPhX candidate_id: 26vafvWSRmbhNcxJYqjCzuJg screening_question_answers: - answer: choice: TypeScript question: remote_id: 48b4d36a-1d4b-4c50-ada7-9519078e65b4 title: Which is your primary programming language type: SINGLE_SELECT custom_fields: {} integration_fields: [] remote_url: https://app.greenhouse.io/applications/32 changed_at: '2022-08-07T14:01:29.196Z' remote_deleted_at: null remote_created_at: '2022-08-07T14:01:29.196Z' remote_updated_at: '2022-08-07T14:01:29.196Z' remote_data: null candidate: id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' first_name: John last_name: Doe email_addresses: - email_address: john.doe@example.com type: PRIVATE phone_numbers: - phone_number: +1-541-754-3010 type: HOME social_media: - link: https://www.youtube.com/watch?v=dQw4w9WgXcQ type: YOUTUBE username: null source: Employee Referral remote_url: https://app.greenhouse.io/people/32 tags: - id: 26vafvWSRmbhNcxJYqjCzuJg remote_id: '32' name: High Potential current_stage: id: 5J7L4b48wBfffYwek9Az9pkM remote_id: '32' name: Initial Screening index: 2 job: id: H5daSm8e85Dmvmne3wLeCPhX remote_id: '32' name: Backend Engineer interviews: - 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' canceled: false offers: - id: 76bab8LKuFtqpZ89mofCPMHX remote_id: '6' status: ACCEPTED required: - status - data responses: ErrorResponseATS: description: The standard error response with the error codes for the ATS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - ATS.JOB_CLOSED - ATS.APPLICATION_ALREADY_EXISTS example: ATS.JOB_CLOSED description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ````