openapi: 3.1.0 info: title: Endpoints subpackage_ats API version: 1.0.0 servers: - url: https://api.letsdeel.com/rest/v2 - url: https://api-staging.letsdeel.com/rest/v2 tags: - name: subpackage_ats paths: /ats/applications/{application_id}/notes: post: operationId: add-note-to-an-application-v-2026-01-01 summary: Add note to an application description: "Create application note: Adds a new note to a specific candidate application. Use this to record interview feedback, recruiter observations, or internal comments during the hiring process. The 'authorId' must correspond to a valid HRIS user. Scope: ats:write\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: application_id in: path description: Id of the application which the note will be added required: true schema: type: string format: uuid - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Application note created successfully content: application/json: schema: $ref: '#/components/schemas/ATS_addNoteToAnApplication-v2026-01-01_Response_201' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/AddNoteToAnApplication-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/AddNoteToAnApplication-v2026-01-01RequestInternalServerError' requestBody: content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData' required: - data /ats/applications/{application_id}/interview-plan-stages: post: operationId: associate-application-with-an-interview-plan-stage-v-2026-01-01 summary: Associate application with an interview plan stage description: "Use this endpoint to associate an application with a specific interview plan stage in the hiring workflow. Use it when moving a candidate into a stage or backfilling history. Set is_current_stage to true to update the application's current stage; set it to false to record a historical entry without changing the current stage. To control triggered activities, pass applicable_job_activities; omit it to trigger all activities or pass an empty array to trigger none. If the candidate is being archived, include candidate_archivation_reason_id and optionally candidate_archivation_email_template_id to send a rejection email.\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: application_id in: path description: ID of the application to be associated with the interview plan stage required: true schema: type: string format: uuid - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Application interview plan stage successfully created content: application/json: schema: $ref: '#/components/schemas/ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201' '400': description: Email body contains placeholders that can't be resolved content: application/json: schema: description: Any type '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' requestBody: content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData' required: - data /ats/applications: post: operationId: create-ats-application-v-2026-01-01 summary: Create ATS Application description: "Use this endpoint to create a new application linking an existing candidate to a job in your ATS. Call it when a candidate applies or when importing applications from another system.\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Successful response with application data content: application/json: schema: $ref: '#/components/schemas/ATS_createAtsApplication-v2026-01-01_Response_201' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateAtsApplication-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateAtsApplication-v2026-01-01RequestInternalServerError' requestBody: content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData' required: - data get: operationId: retrieve-a-list-of-ats-applications-v-2026-01-01 summary: Retrieve a list of ATS applications description: "List applications: Returns a paginated list of candidate applications for an organization. Use this to track and review the progress of candidates across all open positions. Supports cursor-based pagination and filtering via query parameters. Scope: ats:read\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results. required: false schema: type: string - name: limit in: query description: Maximum number of applications to return per page required: false schema: type: integer default: 20 - name: search_text in: query description: Search text to filter applications by candidate name or email required: false schema: type: string - name: job_id in: query description: Filter applications by specific job ID required: false schema: type: string format: uuid - name: interview_plan_stage_ids in: query description: Filter applications by specific interview plan stage IDs required: false schema: type: array items: type: string format: uuid - name: candidate_tag_ids in: query description: Filter applications by candidate tag IDs required: false schema: type: array items: type: string format: uuid - name: source_slugs in: query description: Filter applications by source slugs required: false schema: type: array items: type: string - name: job_criterias_matchings in: query description: Filter applications by job criteria matching state. Each object specifies a job criteria ID and whether the candidate matches it. required: false schema: type: array items: $ref: '#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems' - name: current_stage_category_type_slugs in: query description: Filter applications by current stage category type slugs required: false schema: type: array items: type: string - name: current_stage_default_type_slugs in: query description: Filter applications by current stage default type slugs. Use 'others' for custom stages. required: false schema: type: array items: type: string - name: updated_after in: query description: Filter applications updated after this timestamp (ISO 8601 format) required: false schema: type: string format: date-time - name: sort_by in: query description: Field to sort applications by required: false schema: $ref: '#/components/schemas/AtsApplicationsGetParametersSortBy' - name: sort_order in: query description: Sort order for applications required: false schema: $ref: '#/components/schemas/AtsApplicationsGetParametersSortOrder' - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successfully retrieved applications content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError' /ats/candidates: post: operationId: create-ats-candidate-v-2026-01-01 summary: Create ATS Candidate description: "This endpoint allows the creation of a new candidate within the ATS system. The user must provide all required fields, and the candidate will be created with the specified details.\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Successful response with candidate data content: application/json: schema: $ref: '#/components/schemas/ATS_createAtsCandidate-v2026-01-01_Response_201' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateAtsCandidate-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateAtsCandidate-v2026-01-01RequestInternalServerError' requestBody: content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData' required: - data get: operationId: retrieve-paginated-list-of-ats-candidates-v-2026-01-01 summary: Retrieve paginated list of ATS Candidates description: "Retrieves a list of candidates in the Applicant Tracking System. You can filter candidates by jobs, departments, and tags to narrow down the results\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: search in: query description: Search text for filtering candidates required: false schema: type: string - name: job_ids in: query description: Filter candidates by job IDs required: false schema: type: array items: type: string format: uuid - name: department_ids in: query description: Filter candidates by department IDs required: false schema: type: array items: type: string format: uuid - name: tag_ids in: query description: Filter candidates by tag IDs required: false schema: type: array items: type: string format: uuid - name: current_stage_category_type_slugs in: query description: Filter candidates by current stage category type slugs required: false schema: type: array items: type: string - name: current_stage_default_type_slugs in: query description: Filter candidates by current stage default type slugs required: false schema: type: array items: type: string - name: updated_after in: query description: Filter applications updated after this timestamp (ISO 8601 format) required: false schema: type: string format: date-time - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError' /ats/jobs: post: operationId: create-ats-job summary: Create ATS Job description: "This endpoint allows the creation of a new job within the ATS system. The user must provide all required fields, and the job will be created with the specified details.\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Job successfully created content: application/json: schema: $ref: '#/components/schemas/ATS_createAtsJob_Response_201' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateAtsJobRequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' requestBody: content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/AtsJobsPostRequestBodyContentApplicationJsonSchemaData' get: operationId: retrieve-a-list-of-ats-jobs summary: Retrieve a list of ATS jobs description: "Retrieves a list of all jobs in the Applicant Tracking System. Results can be filtered by query parameters.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: search in: query description: Text to search for in job records (optional) required: false schema: type: string - name: interview_plan_id in: query description: Interview plan UUID (optional) required: false schema: type: string format: uuid - name: location_ids in: query description: Array of location UUIDs (optional) required: false schema: type: array items: type: string format: uuid - name: team_ids in: query description: Array of team UUIDs (optional) required: false schema: type: array items: type: string format: uuid - name: employment_type_ids in: query description: Array of employment type UUIDs (optional) required: false schema: type: array items: type: string format: uuid - name: department_ids in: query description: Array of department UUIDs (optional) required: false schema: type: array items: type: string format: uuid - name: updated_after in: query description: Filter jobs updated after this timestamp (ISO 8601 format) required: false schema: type: string format: date-time - name: status in: query description: Array of job status values (optional) required: false schema: type: array items: $ref: '#/components/schemas/AtsJobsGetParametersStatusSchemaItems' - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsJobs_Response_200' '400': description: Operation failed. content: application/json: schema: type: array items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaItems' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/candidates/{candidate_id}/tags: post: operationId: create-candidate-tags-v-2026-02-27 summary: Create candidate tags description: "This endpoint replaces all existing tags associated with a candidate with a new set. Use this when updating candidate tags is necessary.\n **Token scopes**: `ats:write`" tags: - subpackage_ats parameters: - name: candidate_id in: path description: The unique identifier of the candidate. required: true schema: type: string format: uuid - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '201': description: Successfully created content: application/json: schema: $ref: '#/components/schemas/ATS_createCandidateTags-v2026-02-27_Response_201' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateCandidateTags-v2026-02-27RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/CreateCandidateTags-v2026-02-27RequestInternalServerError' requestBody: content: application/json: schema: type: object properties: tag_ids: type: array items: type: string format: uuid description: List of tag IDs to associate with the candidate required: - tag_ids /ats/tags: get: operationId: list-tags-v-2026-02-27 summary: List tags description: "Use this endpoint to list all tags associated with the organization. View or organize tags based on filters like label or tag group.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: search_text in: query description: Filter tags by label (case-insensitive partial match) required: false schema: type: string - name: tag_group_slug in: query description: Filter by tag group. Use CANDIDATE for candidate tags. required: false schema: $ref: '#/components/schemas/AtsTagsGetParametersTagGroupSlug' - name: include_counts in: query description: When true, each tag includes candidates_count (number of candidates with that tag) required: false schema: $ref: '#/components/schemas/AtsTagsGetParametersIncludeCounts' - name: cursor in: query description: Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page. required: false schema: type: string - name: limit in: query description: 'Maximum number of tags to return per page (default: 20, max: 100).' required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. Returns the list of tags for the organization. content: application/json: schema: $ref: '#/components/schemas/ATS_listTags-v2026-02-27_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ListTags-v2026-02-27RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ListTags-v2026-02-27RequestInternalServerError' /ats/application-sources: get: operationId: retrieve-a-list-of-ats-application-sources summary: Retrieve a list of ATS application sources description: "Retrieves a list of the available application sources in the Applicant Tracking System.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successfully retrieved application sources content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsApplicationSources_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/departments: get: operationId: retrieve-a-list-of-ats-departments summary: Retrieve a list of ATS departments description: "Retrieves a list of all departments in the Applicant Tracking System\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful response with departments data content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsDepartments_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsDepartmentsRequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/employment-types: get: operationId: retrieve-a-list-of-ats-employment-types summary: Retrieve a list of ATS employment types description: "Use this endpoint to fetch employment types available in ATS for syncing and validation workflows.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful response with employment types data content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsEmploymentTypes_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsEmploymentTypesRequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/job-boards/{job_board_id}/job-postings: get: operationId: retrieve-a-list-of-ats-job-postings summary: Retrieve a list of ATS job postings description: "Retrieves a list of all job postings in the Applicant Tracking System. Results can be filtered by query parameters.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: job_board_id in: path description: Job Board ID must be a valid UUID required: true schema: type: string format: uuid - name: cursor in: query description: The cursor for pagination (optional) required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response (optional) required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsJobPostings_Response_200' '400': description: Operation failed. content: application/json: schema: type: array items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/locations: get: operationId: retrieve-a-list-of-ats-locations-v-2026-01-01 summary: Retrieve a list of ATS locations description: "List locations: Returns a paginated list of all locations associated with an organization in ATS. Use this to retrieve available work locations when creating job postings or filtering candidates by location. Scope: ats:read\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful response with locations data content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/offers: get: operationId: retrieve-a-list-of-ats-offers-v-2026-01-01 summary: Retrieve a list of ATS offers description: "List offers: Returns all offers associated with an organization, including worker type and offer status. Use this to review outstanding or accepted offers before initiating onboarding or contract creation workflows. Scope: ats:read\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/email-templates: get: operationId: retrieve-a-list-of-published-ats-email-templates-v-2026-02-11 summary: Retrieve a list of published ATS email templates description: "List email templates: Returns a paginated list of published email templates for an organization. Use this to populate template selectors when composing candidate communications or automating outreach workflows. Supports cursor-based pagination and filtering by update time via the 'updatedAfter' query parameter. Scope: ats:read\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results. required: false schema: type: string - name: limit in: query description: Maximum number of email templates to return per page required: false schema: type: integer default: 20 - name: updated_after in: query description: Return only email templates that were updated after this timestamp (ISO 8601 format) required: false schema: type: string format: date-time - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successfully retrieved email templates content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError' /ats/applications/{application_id}: get: operationId: retrieve-ats-application-v-2026-01-01 summary: Retrieve ATS application description: "This endpoint retrieves a single application by its ID for a specific organization. It provides detailed information about the application, including its associated job details, job posting details, and other relevant metadata.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: application_id in: path description: Unique identifier of the application to retrieve required: true schema: type: string format: uuid - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful response with application data content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAtsApplication-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsApplication-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsApplication-v2026-01-01RequestInternalServerError' /ats/hiring-members: get: operationId: retrieve-ats-hiring-members summary: Retrieve ATS hiring members description: "This endpoint retrieves a list of ATS hiring members. It provides detailed information about each hiring member, including their unique identifier, name, job title, email, profile picture URL, etc. The response also includes pagination details to help navigate through large sets of hiring members.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAtsHiringMembers_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsHiringMembersRequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsHiringMembersRequestInternalServerError' /ats/job-postings/{job_posting_id}: get: operationId: retrieve-ats-job-posting summary: Retrieve ATS job posting description: "This endpoint retrieves a single job posting by its ID. It provides detailed information about the job posting, including its associated job details, publication status, and other relevant metadata.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: job_posting_id in: path description: Unique identifier of the job posting to retrieve required: true schema: type: string format: uuid - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAtsJobPosting_Response_200' '400': description: Operation failed. content: application/json: schema: type: array items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' /ats/job-postings: get: operationId: retrieve-ats-job-postings-v-2026-04-10 summary: Retrieve ATS job postings description: "Use this endpoint to retrieve job postings by specifying the job board ID or job ID. It provides detailed postings with job details, publication status, and relevant metadata.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: job_board_id in: query description: Job board to list postings from (UUID). required: false schema: type: string format: uuid - name: job_id in: query description: When set, only postings for this job are returned (UUID). required: false schema: type: string format: uuid - name: cursor in: query description: Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page. required: false schema: type: string - name: limit in: query description: 'Maximum number of job postings to return per page (min: 1, max: 100).' required: false schema: type: integer - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. Returns job postings for the requested job board (and optional job filter), with nested job details and publication state per board. content: application/json: schema: $ref: '#/components/schemas/ATS_retrieveAtsJobPostings-v2026-04-10_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError' /ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}: get: operationId: retrieve-paginated-list-of-ats-attachment-files-v-2026-01-01 summary: Retrieve paginated list of ATS attachment files description: "Use this endpoint to list attachment files for a specific ATS entity. Provide attachable_type_slug, attachable_id, and attachment_type_slug to specify which entity and attachment type to list.\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: attachable_id in: path description: Unique identifier for the attachable entity required: true schema: type: string format: uuid - name: attachment_type_slug in: path description: Type of the attachment required: true schema: $ref: '#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug' - name: attachable_type_slug in: path description: Type of the attachable entity required: true schema: $ref: '#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug' - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError' /ats/reasons: get: operationId: retrieve-paginated-list-of-ats-rejection-archivation-reasons-v-2026-01-01 summary: Retrieve paginated list of ATS Rejection/Archivation reasons description: "Retrieves a list of rejection or archivation reasons in the Applicant Tracking System. You can filter reasons by group and subgroup to narrow down the results\n **Token scopes**: `ats:read`" tags: - subpackage_ats parameters: - name: cursor in: query description: The cursor for pagination required: false schema: type: string - name: limit in: query description: Maximum number of records returned in one response required: false schema: type: integer default: 20 - name: search in: query description: Search text for filtering candidates required: false schema: type: string - name: reason_group_slug in: query description: Reason group enum required: false schema: $ref: '#/components/schemas/AtsReasonsGetParametersReasonGroupSlug' - name: include_counts in: query description: If sent true, it will fetch result with counts required: false schema: type: string - name: subgroup_slug in: query description: Reason subgroup enum required: false schema: $ref: '#/components/schemas/AtsReasonsGetParametersSubgroupSlug' - name: Authorization in: header description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" required: true schema: type: string responses: '200': description: Successful operation. content: application/json: schema: $ref: '#/components/schemas/ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200' '400': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError' '401': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '403': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '404': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/ApiErrorContainer' '500': description: Operation failed. content: application/json: schema: $ref: '#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError' components: schemas: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems: type: object properties: id: type: string format: uuid description: Candidate tag unique identifier tag: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag' required: - id - tag title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob: type: object properties: id: type: string format: uuid description: Job identifier. job_teams: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems' description: Job-to-team associations; null or omitted when not loaded or not applicable. compensation: oneOf: - $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation' - type: 'null' description: Current compensation when visible on the posting; null when hidden or absent. Shape mirrors internal compensation mapping. job_locations: type: array items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems' description: Work locations associated with the job. job_departments: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems' description: Job-to-department associations; null or omitted when not loaded. job_employment_types: type: array items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems' description: Employment types associated with the job (e.g. full-time, contract). required: - id - compensation - job_locations - job_employment_types description: 'Nested job record: locations, employment types, optional teams/departments, and optional compensation when visible.' title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard: type: object properties: id: type: string format: uuid description: Unique identifier for the job board type: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType' description: Type of job board required: - id - type description: Job board details where the application originated title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard CreateAtsApplication-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems' title: CreateAtsApplication-v2026-01-01RequestInternalServerError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type' description: The type of the question answer: type: string description: The paragraph answer text question_id: type: string description: The unique identifier of the question required: - type - answer - question_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1 AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug: type: string enum: - PUBLISHED_BASIC - PUBLISHED_PREMIUM - UNPUBLISHED - EXPIRED - IN_PROGRESS - FAILED description: State of the job posting publication title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug : type: string enum: - ANNUALLY - MONTHLY - SEMIMONTHLY - BIWEEKLY - WEEKLY - DAILY - HOURLY description: Compensation period title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems: type: object properties: id: type: string format: uuid description: Job-location association row identifier. location: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation' description: Location entity for this association. description: Single job-location link with nested location details. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job criteria matching is_matched: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched' description: Whether the candidate matches this job criteria description: type: string description: Description of how the candidate matches the criteria job_criteria: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria' description: Job criteria details required: - id - is_matched - description - job_criteria title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems AtsTagsGetParametersIncludeCounts: type: string enum: - 'true' - 'false' default: 'false' title: AtsTagsGetParametersIncludeCounts AtsJobsGetResponsesContentApplicationJsonSchemaItems: type: object properties: code: type: string description: Error code of the handler which produced the returned error field: type: string description: The field name where input validation failed message: type: string description: Description of the returned error title: AtsJobsGetResponsesContentApplicationJsonSchemaItems ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum : type: string enum: - ADD_CANDIDATE_TAG - TRANSITION_APPLICATION description: Type of action performed by the automation rule title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage: type: object properties: id: type: string format: uuid description: Application interview plan stage unique identifier application_id: type: string format: uuid description: Application unique identifier interview_plan_stage: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage' interview_plan_stage_id: type: string format: uuid description: Interview plan stage unique identifier required: - id - application_id - interview_plan_stage - interview_plan_stage_id description: Current interview plan stage information for the application title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate: type: object properties: id: type: string format: uuid description: Unique identifier for the candidate email: type: string description: Email address of the candidate last_name: type: string description: Last name of the candidate first_name: type: string description: First name of the candidate attachments: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems' description: Array of attachments associated with the candidate (e.g., resume, cover letter) phone_number: type: - string - 'null' description: Phone number of the candidate candidate_tags: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems' description: Tags associated with the candidate import_session_id: type: - string - 'null' description: Import session identifier if the candidate was bulk imported profile_picture_url: type: - string - 'null' description: Profile picture URL of the candidate required: - id - email - last_name - first_name - attachments - phone_number - candidate_tags - import_session_id - profile_picture_url description: Candidate details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string field: type: string message: type: string title: AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate: type: object properties: id: type: string format: uuid description: Candidate unique identifier email: type: string format: email description: Candidate email address pic_url: type: - string - 'null' description: Candidate profile picture URL last_name: type: string description: Candidate last name first_name: type: string description: Candidate first name phone_number: type: - string - 'null' description: Candidate phone number (may be empty string or null) candidate_tags: type: array items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems' description: Tags associated with the candidate required: - id - email - pic_url - last_name - first_name - phone_number - candidate_tags description: Candidate information associated with the application title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting publication required: - id description: Job posting publication details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication RetrieveAtsApplication-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAtsApplication-v2026-01-01RequestBadRequestError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type: type: string enum: - ADDRESS description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type AtsJobsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job title: type: string description: Job title status: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus' description: Job status job_teams: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems' description: Teams associated with the job created_at: type: string format: date-time description: Timestamp when the job was created updated_at: type: string format: date-time description: Timestamp when the job was last updated job_locations: type: array items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems' description: Locations associated with the job hiring_members: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems' description: Hiring members associated with the job is_confidential: type: boolean description: Indicates if the job is confidential job_departments: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems' description: Departments associated with the job approval_rule_id: type: - string - 'null' format: uuid description: Unique identifier for the approval rule applications_count: type: - integer - 'null' description: Number of applications for the job approval_request_id: type: - string - 'null' format: uuid description: Unique identifier for the approval request current_compensation: oneOf: - $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation' - type: 'null' description: Current compensation details job_employment_types: type: array items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems' description: Employment types associated with the job richtext_description: type: - string - 'null' description: Rich text description of the job interview_plan_stages: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems' description: Interview plan stages approval_request_stringified: type: - string - 'null' description: Stringified approval request created_by_hris_organization_user_id: type: - string - 'null' format: uuid description: Unique identifier of the user who created the job hiring_member_job_permissions_by_type_slug: oneOf: - $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug' - type: 'null' description: Hiring member job permissions by type slug title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job department department: oneOf: - $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment' - type: 'null' description: Details for the department associated with the job required: - id title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Application source unique identifier slug: type: string description: Application source slug created_at: type: string format: date-time description: Timestamp of when the application source was created updated_at: type: string format: date-time description: Timestamp of when the application source was last updated required: - id - slug - created_at - updated_at title: AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage: type: object properties: id: type: string format: uuid description: Identifier of the application interview plan stage record interview_plan_stage: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage' - type: 'null' description: Details of the interview plan stage required: - id - interview_plan_stage description: Current interview plan stage for the application title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage: type: object properties: id: type: string format: uuid description: Unique identifier for the current application interview plan stage status: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus' description: Status of the current application interview plan stage created_at: type: string format: date-time description: Timestamp of when the current application interview plan stage was created application_id: type: string format: uuid description: Unique identifier for the application interview_plan_stage: oneOf: - $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage' - type: 'null' interview_plan_stage_id: type: string format: uuid description: Unique identifier for the interview plan stage title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus: type: string enum: - OPEN - CLOSED - DRAFT - WAITING_FOR_APPROVAL - APPROVED - NOT_APPROVED - ARCHIVED description: Job status title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems: type: object properties: id: type: string format: uuid description: Job criteria matching unique identifier is_matched: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched' description: Whether the criteria is matched description: type: string description: Job criteria matching description job_criteria_id: type: string format: uuid description: Job criteria unique identifier required: - id - is_matched - description - job_criteria_id title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job department department: oneOf: - $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment' - type: 'null' description: Department associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems: type: object properties: answer: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer' question_text: type: string description: Text of the question question_type: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType' description: Type of the question (uppercase) data_binding_id: type: string format: uuid description: Data binding identifier for the question required: - answer - question_text - question_type - data_binding_id description: Parsed form submission answer title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm: type: object properties: id: type: string format: uuid description: Unique identifier for the application form title: type: string description: Title of the application form required: - id - title description: Application form assigned to the job posting title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type' description: The type of the question question_id: type: string description: The unique identifier of the question document_ids: type: array items: type: string description: Array of uploaded document IDs required: - type - question_id - document_ids title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4 AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems: type: object properties: id: type: string format: uuid description: Job-department association row identifier. department: oneOf: - $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment' - type: 'null' description: Department for this association; null if unset. description: Single job-department link with nested department details. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation: type: object properties: id: type: string format: uuid description: Unique identifier for the compensation record max_amount: type: - number - 'null' format: double description: Maximum compensation amount min_amount: type: - number - 'null' format: double description: Minimum compensation amount currency_iso_code: type: string description: Currency ISO code for the compensation required: - id - currency_iso_code description: Compensation information for the job title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment: type: object properties: id: type: string format: uuid description: Unique identifier for the department name: type: string description: Department name description: Details for the department associated with the job title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Application unique identifier job: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob' description: Job information for the application candidate: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate' description: Candidate information associated with the application created_at: type: string format: date-time description: Timestamp of when the application was created numeric_id: type: integer description: Application numeric identifier job_posting: oneOf: - $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting' - type: 'null' description: Job posting information (if application came through a posting) source_slug: oneOf: - $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug' - type: 'null' description: Source of the application job_employment_type: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType' description: Employment type information for the job moved_to_current_stage_at: type: string format: date-time description: Timestamp of when the application moved to current stage application_form_submission: oneOf: - $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission' - type: 'null' description: Application form submission data with parsed answers application_job_criterias_matchings: type: array items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems' description: AI-generated job criteria matching results for the application created_by_hris_organization_user_id: type: - string - 'null' format: uuid description: User who created the application current_application_interview_plan_stage: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage' description: Current interview plan stage information for the application current_application_interview_plan_stage_id: type: - string - 'null' format: uuid description: Current interview plan stage unique identifier application_form_form_builder_form_submission_id: type: - string - 'null' format: uuid description: Application form submission unique identifier required: - id - created_at - numeric_id - moved_to_current_stage_at title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: A description of the returned error title: RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum : type: string enum: - CONTRACTOR - DIRECT_EMPLOYEE - EOR_EMPLOYEE - GLOBAL_PAYROLL_EMPLOYEE - PEO_EMPLOYEE - UNKNOWN description: Type of worker for the offer title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job employment type employment_type: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType' description: Details for the employment type assigned to the job required: - id - employment_type title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug: type: string enum: - CANDIDATE description: Tag group. Use CANDIDATE for candidate tags. title: AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug AtsApplicationsPostResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: Unique identifier for the application job_id: type: string format: uuid description: Unique identifier for the job created_at: type: string format: date-time description: Timestamp when the application was created numeric_id: type: integer description: Numeric identifier for the application updated_at: type: string format: date-time description: Timestamp when the application was last updated candidate_id: type: string format: uuid description: Unique identifier for the candidate job_posting_id: type: - string - 'null' format: uuid description: Unique identifier for the job posting job_employment_type_id: type: - string - 'null' format: uuid description: Unique identifier for the job employment type moved_to_current_stage_at: type: - string - 'null' format: date-time description: Timestamp when the application was moved to the current stage current_application_interview_plan_stage_id: type: - string - 'null' format: uuid description: Unique identifier for the current application interview plan stage required: - id - job_id - created_at - numeric_id - updated_at - candidate_id - job_posting_id - job_employment_type_id - moved_to_current_stage_at - current_application_interview_plan_stage_id title: AtsApplicationsPostResponsesContentApplicationJsonSchemaData AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug: type: string enum: - SOURCED_INTERNALLY - EXTERNAL_CAREER_PAGE - LINKEDIN_PREMIUM - LINKEDIN_BASIC - INTERNAL_CAREER_PAGE - INTERNAL_REFERRAL - BULK_IMPORTED description: Source of the application title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting publication state state_slug: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug' description: State of the job posting publication required: - id - state_slug description: Current state of the job posting publication title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting publication job_board: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard' description: Job board where the posting is published current_state: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState' description: Current publication state details required: - id - job_board - current_state title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType: type: string enum: - CONTRACTOR - DIRECT_EMPLOYEE - EOR_EMPLOYEE - GLOBAL_PAYROLL_EMPLOYEE - PEO_EMPLOYEE - UNKNOWN description: Worker type title: AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob: type: object properties: id: type: string format: uuid description: Unique identifier for the job title: type: string description: Title of the job required: - id - title description: Job details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation: type: object properties: id: type: string format: uuid description: Unique identifier for the location name: type: string description: Location name description: Location associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate: type: object properties: id: type: string format: uuid description: Email template ID title: type: string description: Email template title required: - id - title description: Associated email template title: AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail: type: object properties: id: type: string format: uuid description: Unique identifier for the email body: type: string description: Email body subject: type: string description: Email subject sender_name: type: string description: Sender name recipient_cc: type: - string - 'null' format: email description: Carbon-copy recipient email address recipient_to: type: string format: email description: Primary recipient email address recipient_bcc: type: - string - 'null' format: email description: Blind-carbon-copy recipient email address description: Email details title: AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type' description: The type of the question question_id: type: string description: The unique identifier of the question selected_option_ids: type: array items: type: string description: Array of selected option IDs required: - type - question_id - selected_option_ids title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6 AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type: type: string enum: - FREETEXT description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type AtsTagsGetParametersTagGroupSlug: type: string enum: - CANDIDATE title: AtsTagsGetParametersTagGroupSlug AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard: type: object properties: id: type: string format: uuid description: Unique identifier for the job board required: - id description: Job board where the posting is published title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard AtsJobsGetParametersStatusSchemaItems: type: string enum: - OPEN - CLOSED - DRAFT - WAITING_FOR_APPROVAL - APPROVED - NOT_APPROVED - ARCHIVED title: AtsJobsGetParametersStatusSchemaItems AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus: type: string enum: - ACTIVE - COMPLETED - PENDING - REJECTED description: Status of the current application interview plan stage title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug: type: object properties: hiring_team: type: string description: Hiring team permissions job_posting: type: string description: Job posting permissions compensation: type: string description: Compensation permissions interview_plan: type: string description: Interview plan permissions application_form_submission: type: string description: Application form submission permissions application_form_submission_sensitive_fields: type: string description: Application form submission sensitive fields permissions description: Hiring member job permissions by type slug title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug RetrieveAListOfAtsEmploymentTypesRequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfAtsEmploymentTypesRequestBadRequestError RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError: type: object properties: path: type: string description: Request URL path timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - timestamp - status_code title: RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type' description: The type of the question email: type: string format: email description: The email address question_id: type: string description: The unique identifier of the question required: - type - email - question_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11 AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Error code field: type: string description: Request field related to the error, if applicable message: type: string description: Human-readable error message required: - code - field - message title: AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus: type: string enum: - DRAFT - WAITING_FOR_APPROVAL - APPROVED - NOT_APPROVED - OPEN - CLOSED - ARCHIVED description: Current status of the job title: AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation: type: object properties: id: type: string format: uuid description: Unique identifier for the location name: type: string description: Location name required: - id - name description: Details for the location assigned to the job title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job location location: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation' description: Details for the location assigned to the job required: - id - location title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems ATS_addNoteToAnApplication-v2026-01-01_Response_201: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData' required: - data title: ATS_addNoteToAnApplication-v2026-01-01_Response_201 AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type: type: string enum: - DOCUMENTUPLOAD description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type AtsCandidatesPostResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: Unique identifier for the candidate email: type: string format: email description: Email address of the candidate source: type: - string - 'null' description: Source of the candidate pic_url: type: - string - 'null' description: Profile picture URL of the candidate last_name: type: string description: Last name of the candidate created_at: type: string format: date-time description: Timestamp when the candidate was created first_name: type: string description: First name of the candidate numeric_id: type: integer description: Numeric identifier for the candidate updated_at: type: string format: date-time description: Timestamp when the candidate was last updated imported_id: type: - string - 'null' description: Imported identifier phone_number: type: - string - 'null' description: Phone number of the candidate anonymized_at: type: - string - 'null' format: date-time description: Timestamp when the candidate was anonymized import_session_id: type: - string - 'null' description: Import session identifier final_archivation_at: type: - string - 'null' format: date-time description: Timestamp when the candidate was finally archived linkedin_profile_url: type: - string - 'null' description: LinkedIn profile URL of the candidate required: - id - email - last_name - created_at - first_name - numeric_id - updated_at title: AtsCandidatesPostResponsesContentApplicationJsonSchemaData ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more locations available next_cursor: type: - string - 'null' description: Cursor for pagination to get the next set of results total_count: type: integer description: Total number of locations available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200 ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems' description: Array of attachment objects has_more: type: boolean description: Indicates if there are more results available next_cursor: type: - string - 'null' description: Cursor for pagination to fetch next page total_count: type: number format: double description: Total count of attachments required: - data - has_more - next_cursor - total_count title: ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200 AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam: type: object properties: id: type: string format: uuid description: Unique identifier for the team name: type: string description: Team name required: - id - name description: Details for the team assigned to the job title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier of the candidate-tag association. tag_id: type: string format: uuid description: Unique identifier of the tag. created_at: type: string format: date-time description: When the association was created. candidate_id: type: string format: uuid description: Unique identifier of the candidate. title: AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam: type: object properties: id: type: string format: uuid description: Unique identifier for the team name: type: string description: Team name required: - id - name description: Details for the team assigned to the job title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Error code field: type: string description: Request field related to the error, if applicable message: type: string description: Human-readable error message required: - code - field - message title: AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string field: type: string message: type: string title: AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum : type: string enum: - CREATED - WAITING_FOR_APPROVAL - APPROVED - NOT_APPROVED - SENT - ACCEPTED - REJECTED description: Status of the offer title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems: type: object properties: id: type: string format: uuid description: Job-employment-type association row identifier. employment_type: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType' description: Employment type entity for this association. description: Single job–employment-type link with nested employment type details. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType: type: string enum: - FREETEXT - PARAGRAPH - SINGLESELECTION - MULTISELECTION - DOCUMENTUPLOAD - PRESETDROPDOWN - CUSTOMDROPDOWN - NUMBER - DATEPICKER - ADDRESS - PHONENUMBER - EMAIL description: Type of the question (uppercase) title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError RetrieveAListOfAtsDepartmentsRequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfAtsDepartmentsRequestBadRequestError AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string field: type: string message: type: string title: AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems: type: object properties: id: type: string format: uuid description: Job posting publication identifier. job_board: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard' description: Job board this publication belongs to. current_state: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState' description: Latest known publication state for this board. required: - id - job_board - current_state description: Single publication of the job posting to a job board. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType: type: string enum: - FREETEXT - PARAGRAPH - SINGLESELECTION - MULTISELECTION - DOCUMENTUPLOAD - PRESETDROPDOWN - CUSTOMDROPDOWN - NUMBER - DATEPICKER - ADDRESS - PHONENUMBER - EMAIL description: Type of the question (uppercase) title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug: type: string enum: - ANNUALLY - MONTHLY - SEMIMONTHLY - BIWEEKLY - WEEKLY - DAILY - HOURLY description: Compensation period title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the location city: type: - string - 'null' description: City name name: type: string description: Name of the location/country is_remote: type: boolean description: Indicates if this is a remote location created_at: type: string format: date-time description: Timestamp when the location was created updated_at: type: string format: date-time description: Timestamp when the location was last updated country_code: type: - string - 'null' description: ISO country code location_group: oneOf: - $ref: '#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup' - type: 'null' description: Location group information province_or_region_text: type: - string - 'null' description: Province or region text required: - id - name - created_at - updated_at title: AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type' description: The type of the question question_id: type: string description: The unique identifier of the question phone_number: type: string description: The phone number required: - type - question_id - phone_number title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10 AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type: type: string enum: - MULTISELECTION description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type' description: The type of the question end_date: type: string description: The end date selected (for ranges) start_date: type: string description: The start date selected question_id: type: string description: The unique identifier of the question required: - type - question_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8 AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the reason label: type: string description: Label of the reason created_at: type: string format: date-time description: Timestamp when the reason was created jobs_count: type: - number - 'null' format: double description: Number of jobs associated with this reason updated_at: type: string format: date-time description: Timestamp when the reason was last updated subgroup_slug: oneOf: - $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug' - type: 'null' description: Reason subgroup slug email_template: oneOf: - $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate' - type: 'null' description: Associated email template candidates_count: type: - number - 'null' format: double description: Number of candidates associated with this reason reason_group_slug: $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug' description: Reason group slug required: - id - label - created_at - reason_group_slug title: AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation: type: object properties: id: type: string format: uuid description: Unique identifier for the compensation record max_amount: type: - number - 'null' format: double description: Maximum compensation amount min_amount: type: - number - 'null' format: double description: Minimum compensation amount currency_iso_code: type: string description: Currency ISO code for the compensation required: - id - currency_iso_code description: Compensation information for the job title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the candidate tag tag: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag' description: Tag details required: - id - tag description: Candidate tag title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type' description: The type of the question question_id: type: string description: The unique identifier of the question selected_option_id: type: string description: The ID of the selected option required: - type - question_id - selected_option_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2 ATS_createAtsApplication-v2026-01-01_Response_201: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaData' required: - data title: ATS_createAtsApplication-v2026-01-01_Response_201 AtsTagsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier of the tag. label: type: string description: Display name of the tag. created_at: type: string format: date-time description: When the tag was created. updated_at: type: string format: date-time description: When the tag was last updated. tag_group_slug: $ref: '#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug' description: Tag group. Use CANDIDATE for candidate tags. candidates_count: type: - integer - 'null' description: Number of candidates with this tag. Present only when includeCounts=true. created_by_hris_organization_user_id: type: - string - 'null' format: uuid description: ID of the user who created the tag, if any. updated_by_hris_organization_user_id: type: - string - 'null' format: uuid description: ID of the user who last updated the tag, if any. required: - id - created_at - updated_at title: AtsTagsGetResponsesContentApplicationJsonSchemaDataItems AtsReasonsGetParametersReasonGroupSlug: type: string enum: - CANDIDATE_ARCHIVATION - OFFER_REJECTION - JOB_CLOSURE title: AtsReasonsGetParametersReasonGroupSlug ATS_listTags-v2026-02-27_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItems' description: List of tags. has_more: type: boolean description: Whether more results exist (pagination). next_cursor: type: - string - 'null' description: Cursor for the next page of results, or null if none. total_count: type: integer description: Total number of tags returned. required: - data - has_more - next_cursor - total_count title: ATS_listTags-v2026-02-27_Response_200 AddNoteToAnApplication-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems' title: AddNoteToAnApplication-v2026-01-01RequestBadRequestError AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment: type: object properties: id: type: string format: uuid description: Department ID name: type: string description: Department name required: - id - name title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment ? AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems : type: object properties: role_slug: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug' description: The role of the participant in the activity participant_hris_organization_user_id: type: string format: uuid description: The HRIS organization user ID of the participant required: - role_slug - participant_hris_organization_user_id title: AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard: type: object properties: id: type: string format: uuid description: Unique identifier for the job board required: - id description: Job board where the posting is published title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting job: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob' description: Associated job information title: type: string description: Job posting title created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp publications: type: array items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems' description: Publication information for different job boards application_form: oneOf: - $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm' - type: 'null' description: Application form assigned to the job posting richtext_description: type: - string - 'null' description: Rich text description of the job posting is_compensation_visible: type: boolean description: Indicates if compensation details are visible to candidates required: - id - job - title - created_at - updated_at - publications - richtext_description - is_compensation_visible title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems ATS_createCandidateTags-v2026-02-27_Response_201: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems' description: List of created candidate-tag associations. required: - data title: ATS_createCandidateTags-v2026-02-27_Response_201 AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting title: type: string description: Title of the job posting required: - id - title description: Job posting details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting RetrieveAtsApplication-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAtsApplication-v2026-01-01RequestInternalServerError AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus: type: string enum: - CREATED - WAITING_FOR_APPROVAL - APPROVED - NOT_APPROVED - SENT - ACCEPTED - REJECTED description: Offer status title: AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob: type: object properties: id: type: string format: uuid description: Unique identifier for the job job_teams: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems' description: Teams associated with the job compensation: oneOf: - $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation' - type: 'null' description: Compensation information for the job job_locations: type: array items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems' description: Locations associated with the job job_departments: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems' description: Departments associated with the job job_employment_types: type: array items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems' description: Employment types associated with the job required: - id - compensation - job_locations - job_employment_types description: Associated job information title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob CreateCandidateTags-v2026-02-27RequestInternalServerError: type: object properties: path: type: string description: Request URL path timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - timestamp - status_code title: CreateCandidateTags-v2026-02-27RequestInternalServerError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems: oneOf: - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10' - $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11' title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage : type: object properties: id: type: string format: uuid description: Unique identifier for the interview plan stage name: type: string description: Name of the interview plan stage default_type_slug: type: - string - 'null' description: Default type slug of the interview plan stage category_type_slug: type: string description: Interview plan stage category type required: - id - name - default_type_slug - category_type_slug description: Interview plan stage details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the department name: type: string description: Name of the department created_at: type: string format: date-time description: Timestamp when the department was created updated_at: type: string format: date-time description: Timestamp when the department was last updated required: - id - name - created_at - updated_at title: AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug: type: string enum: - SOURCED_INTERNALLY - EXTERNAL_CAREER_PAGE - LINKEDIN_PREMIUM - LINKEDIN_BASIC - INTERNAL_CAREER_PAGE - INTERNAL_REFERRAL - BULK_IMPORTED description: Source of the application title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug: type: string enum: - INTEREST - LOCATION - COMPENSATION - RESPONSIVENESS - QUALIFICATION - FIT - EXPERIENCE - STATUS - ROLE_CHANGE - BENEFITS - COUNTER_OFFER - REMOTE_WORK - PERSONAL - TIMING - BUDGET - BUSINESS_NEEDS - EXTERNAL_CANDIDATE - INTERNAL_TRANSFER - HIRING_FREEZE description: Reason subgroup slug title: AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job department department: oneOf: - $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment' - type: 'null' description: Details for the department associated with the job required: - id title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: The unique identifier of the application note created_at: type: string format: date-time description: The timestamp when the application note was created updated_at: type: string format: date-time description: The timestamp when the application note was last updated required: - id - created_at - updated_at title: AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType: type: object properties: id: type: string format: uuid description: Identifier of the job employment type record employment_type: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType' description: Employment type metadata required: - id - employment_type description: Employment type associated with the application title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType ATS_retrieveAListOfAtsApplicationSources_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more application sources to fetch next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of application sources available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfAtsApplicationSources_Response_200 ApiErrorContainer: type: object properties: request: $ref: '#/components/schemas/ApiErrorRequest' errors: type: array items: $ref: '#/components/schemas/ApiError' title: ApiErrorContainer AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug: type: string enum: - PUBLISHED_BASIC - PUBLISHED_PREMIUM - UNPUBLISHED - EXPIRED - IN_PROGRESS - FAILED description: Current publication state title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting job: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob' description: Associated job information title: type: string description: Job posting title created_at: type: string format: date-time description: Creation timestamp updated_at: type: string format: date-time description: Last update timestamp publications: type: array items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems' description: Publication information for different job boards application_form: oneOf: - $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm' - type: 'null' description: Application form assigned to the job posting richtext_description: type: - string - 'null' description: Rich text description of the job posting is_compensation_visible: type: boolean description: Indicates if compensation details are visible to candidates required: - id - job - title - created_at - updated_at - publications - richtext_description - is_compensation_visible title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code field: type: string description: Name of the field causing the error (for validation issues) message: type: string description: Human-readable explanation of the error title: AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm: type: object properties: id: type: string format: uuid description: Unique identifier for the application form title: type: string description: Title of the application form required: - id - title description: Application form assigned to the job posting title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError: type: object properties: path: type: string description: Request URL path errors: type: array items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems' description: List of error objects timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - errors - timestamp - status_code title: RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems: type: object properties: id: type: string format: uuid description: Job department relationship ID department: oneOf: - $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment' - type: 'null' required: - id - department title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems ATS_createAtsCandidate-v2026-01-01_Response_201: type: object properties: data: $ref: '#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaData' required: - data title: ATS_createAtsCandidate-v2026-01-01_Response_201 AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier of the job posting. job: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob' description: 'Nested job record: locations, employment types, optional teams/departments, and optional compensation when visible.' title: type: string description: Public title of the job posting. job_id: type: string format: uuid description: Identifier of the underlying job this posting belongs to. created_at: type: string format: date-time description: ISO 8601 timestamp when the posting was created, if present. updated_at: type: string format: date-time description: ISO 8601 timestamp when the posting was last updated, if present. publications: type: array items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems' description: Publication rows for this posting, one per job board integration, with current state. application_form: oneOf: - $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm' - type: 'null' description: Linked application form metadata when the posting uses an application form. richtext_description: type: - string - 'null' description: Rich-text (HTML) job description for the posting, or null if not set. is_compensation_visible: type: boolean description: Whether compensation details may be shown for this posting. required: - id - job - title - job_id - publications - richtext_description - is_compensation_visible title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage : type: object properties: id: type: string format: uuid description: Identifier of the interview plan stage name: type: string description: Name of the interview plan stage default_type_slug: type: - string - 'null' description: Default type slug of the interview plan stage category_type_slug: type: string description: Category type slug of the interview plan stage required: - id - name - default_type_slug - category_type_slug description: Details of the interview plan stage title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Email template unique identifier title: type: string description: Email template title created_at: type: string format: date-time description: Timestamp of when the email template was created updated_at: type: string format: date-time description: Timestamp of when the email template was last updated required: - id - title - created_at - updated_at title: AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems: type: object properties: id: type: string format: uuid description: Job-team association row identifier. team: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam' description: Team referenced by this association. description: Single job-team link with nested team details. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm: type: object properties: id: type: string format: uuid description: Application form identifier. title: type: string description: Human-readable application form title. description: Linked application form metadata when the posting uses an application form. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type' description: The type of the question preset: type: string description: The preset used question_id: type: string description: The unique identifier of the question selected_options: type: array items: type: string description: Array of selected options required: - type - preset - question_id - selected_options title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5 AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the employment type name: type: string description: Name of the employment type created_at: type: string format: date-time description: Timestamp when the employment type was created updated_at: type: string format: date-time description: Timestamp when the employment type was last updated required: - id - name - created_at - updated_at title: AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems ATS_retrieveAListOfAtsEmploymentTypes_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more employment types available next_cursor: type: - string - 'null' description: Cursor for pagination to get the next set of results total_count: type: integer description: Total number of employment types available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfAtsEmploymentTypes_Response_200 AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam: type: object properties: id: type: string format: uuid description: Team identifier. name: type: string description: Display name of the team. description: Team referenced by this association. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup: type: object properties: id: type: string format: uuid description: Unique identifier for the location group name: type: string description: Name of the location group description: Location group information title: AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup CreateAtsCandidate-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems' title: CreateAtsCandidate-v2026-01-01RequestInternalServerError AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType: type: object properties: id: type: string format: uuid description: Unique identifier for the employment type name: type: string description: Employment type name description: Employment type associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag: type: object properties: id: type: string format: uuid description: Tag unique identifier label: type: string description: Tag label required: - id - label title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the attachment ai_summary: type: - string - 'null' description: AI-generated summary of the attachment content required: - id - ai_summary title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType: type: object properties: id: type: string format: uuid description: Employment type unique identifier name: type: string description: Employment type name required: - id - name title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug: type: string enum: - CANDIDATE - CAREER_PAGE_SETTING - JOB_POSTING - NOTE - OFFER - SENT_CANDIDATE_EMAIL - EMAIL_MESSAGE - TEMPORARY - EMAIL_TEMPLATE - JOB_ACTIVITY title: AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug ApiErrorRequest: type: object properties: method: type: string description: The HTTP method of the failed request url: type: string description: The relative URL of the failed request status: type: number format: double description: The status code of the response api_req_id: type: string description: The request ID of the failed request docs: type: string description: A link to the official documentation for the requested endpoint resource source: type: string description: The source handler which produced the returned error code: type: number format: double description: The code of the source handler which produced the returned error title: ApiErrorRequest AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation: type: object properties: id: type: string format: uuid description: Location ID name: type: string description: Location name required: - id - name title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag: type: object properties: id: type: string format: uuid description: Unique identifier for the tag label: type: string description: Label of the tag required: - id - label description: Tag details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type: type: string enum: - CUSTOMDROPDOWN description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag: type: object properties: id: type: string format: uuid description: Unique identifier for the tag label: type: string description: Label for the tag title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched: type: string enum: - MATCHED - NOT_MATCHED - UNDECIDED description: The matching state for the job criteria title: AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting: type: object properties: id: type: string format: uuid description: Job posting unique identifier title: type: string description: Job posting title required: - id - title description: Job posting information (if application came through a posting) title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the note created_at: type: string format: date-time description: Timestamp when the note was created created_by: type: string format: uuid description: Unique identifier for the user who created the note updated_at: type: string format: date-time description: Timestamp when the note was last updated richtext_content: type: string description: Rich text content of the note required: - id - created_at - created_by - updated_at - richtext_content description: Note associated with the application title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type' description: The type of the question question_id: type: string description: The unique identifier of the question selected_option_ids: type: array items: type: string description: Array of selected option IDs required: - type - question_id - selected_option_ids title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3 AtsApplicationsGetParametersSortOrder: type: string enum: - ASC - DESC title: AtsApplicationsGetParametersSortOrder AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData: type: object properties: email: type: string format: email description: The candidate's email address pic_url: type: - string - 'null' format: uri description: The candidate's picture URL last_name: type: string description: The candidate's last name first_name: type: string description: The candidate's first name phone_number: type: - string - 'null' description: The candidate's phone number linkedin_profile_url: type: - string - 'null' format: uri description: The candidate's LinkedIn profile URL required: - email - last_name - first_name title: AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more applications to fetch next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of applications available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200 AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job employment type employment_type: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType' description: Details for the employment type assigned to the job required: - id - employment_type title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit: type: string enum: - hours - days - weeks description: The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at. title: AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType: type: object properties: id: type: string format: uuid description: Unique identifier for the employment type name: type: string description: Employment type name required: - id - name description: Details for the employment type assigned to the job title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type: type: string enum: - PHONENUMBER description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems: type: object properties: id: type: string format: uuid description: Job employment type relationship ID employment_type: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType' required: - id - employment_type title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems: type: object properties: answer: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer' description: The answer value question_text: type: string description: Text of the question question_type: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType' description: Type of the question (uppercase) data_binding_id: type: string description: Data binding identifier for the question required: - answer - question_text - question_type - data_binding_id title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems' description: Array of reason objects has_more: type: boolean description: Indicates if there are more results available next_cursor: type: - string - 'null' description: Cursor for pagination to fetch next page total_count: type: number format: double description: Total count of reasons required: - data - has_more - next_cursor - total_count title: ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200 AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type: type: string enum: - PRESETDROPDOWN description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job team team: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam' description: Details for the team assigned to the job required: - id - team title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: A description of the returned error title: RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the automation rule execution action_type_enum: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum' description: Type of action performed by the automation rule evaluation_result: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems' description: Array of condition evaluations for the automation rule application_automation_rule_id: type: string format: uuid description: Unique identifier for the application automation rule required: - id - action_type_enum - evaluation_result - application_automation_rule_id title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer: oneOf: - type: string - type: number format: double description: The answer value title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: A description of the returned error title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob: type: object properties: id: type: string format: uuid description: Job unique identifier title: type: string description: Job title required: - id - title description: Job information for the application title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems: type: object properties: id: type: string format: uuid description: The ID of the job activity to trigger participants: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems' description: Optional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used. candidate_self_scheduling_email_template_id: type: string format: uuid description: Optional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities) required: - id title: AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type: type: string enum: - SINGLESELECTION description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation: type: object properties: id: type: string format: uuid description: Compensation record identifier. max_amount: type: - number - 'null' format: double description: Maximum compensation amount in the given currency, or null. min_amount: type: - number - 'null' format: double description: Minimum compensation amount in the given currency, or null. currency_iso_code: type: string description: ISO 4217 alphabetic currency code for the compensation amounts. description: Current compensation when visible on the posting; null when hidden or absent. Shape mirrors internal compensation mapping. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard: type: object properties: id: type: string format: uuid description: Job board identifier. required: - id description: Job board this publication belongs to. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard AtsReasonsGetParametersSubgroupSlug: type: string enum: - INTEREST - LOCATION - COMPENSATION - RESPONSIVENESS - QUALIFICATION - FIT - EXPERIENCE - STATUS - ROLE_CHANGE - BENEFITS - COUNTER_OFFER - REMOTE_WORK - PERSONAL - TIMING - BUDGET - BUSINESS_NEEDS - EXTERNAL_CANDIDATE - INTERNAL_TRANSFER - HIRING_FREEZE title: AtsReasonsGetParametersSubgroupSlug ATS_createAtsJob_Response_201: type: object properties: data: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaData' title: ATS_createAtsJob_Response_201 AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug: type: string enum: - CV - LOGO - OFFER_LETTER - OTHER title: AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug ATS_retrieveAListOfAtsJobs_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more items to fetch. next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of jobs title: ATS_retrieveAListOfAtsJobs_Response_200 AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type: type: string enum: - EMAIL description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job posting publication job_board: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard' description: Job board where the posting is published current_state: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState' description: Current publication state details required: - id - job_board - current_state title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug: type: string enum: - PUBLISHED_BASIC - PUBLISHED_PREMIUM - UNPUBLISHED - EXPIRED - IN_PROGRESS - FAILED description: Current publication state title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the candidate tag tag: oneOf: - $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag' - type: 'null' tag_id: type: string format: uuid description: Unique identifier for the tag candidate_id: type: string format: uuid description: Unique identifier for the candidate title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems RetrieveAtsHiringMembersRequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAtsHiringMembersRequestInternalServerError AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the interview plan stage name: type: string description: Interview plan stage name position_number: type: - integer - 'null' description: Position number of the stage in the interview plan default_type_slug: type: - string - 'null' description: Default type slug of the interview plan stage interview_plan_id: type: string format: uuid description: Interview plan ID associated with this stage category_type_slug: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug' description: Category type of the interview plan stage title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems RetrieveAtsHiringMembersRequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAtsHiringMembersRequestBadRequestError AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType: type: object properties: id: type: string format: uuid description: Unique identifier for the employment type name: type: string description: Employment type name required: - id - name description: Details for the employment type assigned to the job title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType ApiError: type: object properties: message: type: string description: A description of the returned error path: type: string description: The JSON path where input validation failed title: ApiError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type' description: The type of the question answer: type: string description: The answer text question_id: type: string description: The unique identifier of the question required: - type - answer - question_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0 AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems: type: object properties: id: type: string format: uuid description: Job team relationship ID team: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam' required: - id - team title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more items to fetch. next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of candidates title: ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200 ATS_retrieveAtsApplication-v2026-01-01_Response_200: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData' required: - data title: ATS_retrieveAtsApplication-v2026-01-01_Response_200 AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched: type: string enum: - MATCHED - NOT_MATCHED - UNDECIDED description: Whether the candidate matches this job criteria title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType: type: object properties: id: type: string format: uuid description: Employment type ID name: type: string description: Employment type name required: - id - name title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError ATS_retrieveAListOfAtsJobPostings_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more results available next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of job postings title: ATS_retrieveAListOfAtsJobPostings_Response_200 AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems ATS_retrieveAtsJobPostings-v2026-04-10_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems' description: Job postings returned for this request (single page; pagination not yet implemented). has_more: type: boolean description: Whether additional pages exist; currently always false for this endpoint. next_cursor: type: - string - 'null' description: Opaque cursor for the next page; currently always null until pagination is implemented. total_count: type: integer description: Number of job postings included in `data` for this response. required: - data - has_more - next_cursor - total_count title: ATS_retrieveAtsJobPostings-v2026-04-10_Response_200 AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob: type: object properties: id: type: string format: uuid description: Unique identifier for the job job_teams: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems' description: Teams associated with the job compensation: oneOf: - $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation' - type: 'null' description: Compensation information for the job job_locations: type: array items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems' description: Locations associated with the job job_departments: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems' description: Departments associated with the job job_employment_types: type: array items: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems' description: Employment types associated with the job required: - id - compensation - job_locations - job_employment_types description: Associated job information title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the attachment url: type: string format: url description: URL of the attachment file_name: type: string description: Name of the file ai_summary: type: - string - 'null' description: AI-generated summary of the attachment created_at: type: string format: date-time description: Timestamp when the attachment was created updated_at: type: string format: date-time description: Timestamp when the attachment was last updated attachable_id: type: string format: uuid description: Unique identifier for the attachable entity file_content_type: type: string description: Content type of the file attachable_type_slug: type: string description: Type of the attachable entity attachment_type_slug: type: string description: Type of the attachment created_by_hris_organization_user_id: type: - string - 'null' format: uuid description: User ID who created the attachment required: - id - file_name - file_content_type - attachable_type_slug - attachment_type_slug title: AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type: type: string enum: - DATEPICKER description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type' description: The type of the question question_id: type: string description: The unique identifier of the question address_city: type: string description: City address_state: type: string description: State address_number: type: string description: Street number address_street: type: string description: Street name address_country: type: string description: Country address_zip_code: type: string description: ZIP code required: - type - question_id - address_city - address_state - address_number - address_street - address_country - address_zip_code title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9 AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems: type: object properties: id: type: string format: uuid description: Job location relationship ID location: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation' required: - id - location title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems ListTags-v2026-02-27RequestInternalServerError: type: object properties: path: type: string description: Request URL path timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - timestamp - status_code title: ListTags-v2026-02-27RequestInternalServerError AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation: type: object properties: id: type: string format: uuid description: Unique identifier for the location name: type: string description: Location name required: - id - name description: Details for the location assigned to the job title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation AtsApplicationsGetParametersSortBy: type: string enum: - APPLICATION_CREATION_DATE - STAGE_CREATION_DATE title: AtsApplicationsGetParametersSortBy AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage: type: object properties: id: type: string format: uuid description: Interview plan stage unique identifier name: type: string description: Interview plan stage name default_type_slug: type: - string - 'null' description: Interview plan stage default type slug category_type_slug: type: string description: Interview plan stage category type required: - id - name - default_type_slug - category_type_slug title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage CreateAtsCandidate-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems' title: CreateAtsCandidate-v2026-01-01RequestBadRequestError ? AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug : type: string enum: - REVIEWER - INTERVIEWER description: The role of the participant in the activity title: AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched: type: string enum: - MATCHED - NOT_MATCHED - UNDECIDED description: Whether the criteria is matched title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob: type: object properties: id: type: string format: uuid description: Unique identifier for the job title: type: string description: Job title title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems: type: object properties: richtext_content: type: string description: The richtext content of the note required: - richtext_content title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems: type: object properties: id: type: - string - 'null' format: uuid description: Unique identifier for the application job: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob' created_at: type: string format: date-time description: Timestamp of when the application was created current_application_interview_plan_stage: oneOf: - $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage' - type: 'null' title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam: type: object properties: id: type: string format: uuid description: Team ID name: type: string description: Team name required: - id - name title: AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission: type: object properties: id: type: - string - 'null' format: uuid description: Identifier of the referral form submission form_builder_stringified: type: - string - 'null' description: Stringified JSON data for the referral form submission required: - id - form_builder_stringified description: Referral form submission metadata title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData: type: object properties: creator_id: type: string format: uuid description: HRIS Organization User ID of the user creating the resource delay_unit: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit' description: The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at. delay_amount: type: integer description: The amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at. is_current_stage: type: boolean description: When true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage. scheduled_send_at: type: string format: date-time description: The exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit. interview_plan_stage_id: type: string format: uuid description: The ID of the interview plan stage to associate with the application applicable_job_activities: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems' description: Optional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered. candidate_archivation_reason_id: type: string format: uuid description: Optional ID of the archivation reason if the candidate is being archived candidate_archivation_email_template_id: type: string format: uuid description: Optional ID of the rejection email template if the candidate is being archived required: - creator_id - is_current_stage - interview_plan_stage_id title: AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType: type: object properties: id: type: string format: uuid description: Identifier of the employment type name: type: string description: Human readable employment type required: - id - name description: Employment type metadata title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer: oneOf: - type: string - type: number format: double title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData: type: object properties: author_id: type: string format: uuid description: The UUID of the HRIS organization user creating the note richtext_content: type: string description: The content of the note in rich text HTML format required: - author_id - richtext_content title: AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState: type: object properties: id: type: string format: uuid description: Unique identifier for the publication state created_at: type: string format: date-time description: Timestamp when the publication was created created_by: type: - string - 'null' format: uuid description: User who created the publication state_slug: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug' description: Current publication state error_message: type: - string - 'null' description: Error message if publication failed required: - id - created_at - state_slug description: Current publication state details title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more email templates to fetch next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of email templates available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200 AtsJobsPostResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: Unique identifier for the created job title: type: string description: The job title status: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus' description: Current status of the job job_teams: type: array items: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems' description: Teams associated with the job created_at: type: string format: date-time description: Timestamp when the job was created updated_at: type: string format: date-time description: Timestamp when the job was last updated job_locations: type: array items: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems' description: Locations associated with the job is_confidential: type: boolean description: Whether the job posting is confidential job_departments: type: - array - 'null' items: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems' description: Departments associated with the job approval_rule_id: type: - string - 'null' format: uuid description: ID of the approval rule applied to this job approval_request_id: type: - string - 'null' format: uuid description: ID of the approval request for this job job_employment_types: type: array items: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems' description: Employment types associated with the job richtext_description: type: - string - 'null' description: Rich text description of the job created_by_hris_organization_user_id: type: - string - 'null' format: uuid description: ID of the user who created the job required: - id - title - status - job_teams - job_locations - is_confidential - approval_rule_id - approval_request_id - job_employment_types - created_by_hris_organization_user_id title: AtsJobsPostResponsesContentApplicationJsonSchemaData AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems: type: object properties: id: type: string format: uuid description: Unique identifier for the hiring member hris_organization_user_id: type: string format: uuid description: Unique identifier for the HRIS organization user title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: A description of the returned error title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment: type: object properties: id: type: string format: uuid description: Department identifier. name: type: string description: Display name of the department. description: Department for this association; null if unset. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type: type: string enum: - NUMBER description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission: type: object properties: id: type: - string - 'null' format: uuid description: Identifier of the application form submission answers: type: - array - 'null' items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems' description: Array of parsed form submission answers required: - id - answers description: Application form submission data with parsed answers title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7: type: object properties: type: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type' description: The type of the question value: type: string description: The numeric answer value question_id: type: string description: The unique identifier of the question required: - type - value - question_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7 AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug: type: string enum: - CANDIDATE_ARCHIVATION - OFFER_REJECTION - JOB_CLOSURE description: Reason group slug title: AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug AddNoteToAnApplication-v2026-01-01RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems' title: AddNoteToAnApplication-v2026-01-01RequestInternalServerError AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment: type: object properties: id: type: string format: uuid description: Unique identifier for the department name: type: string description: Department name description: Details for the department associated with the job title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type: type: string enum: - PARAGRAPH description: The type of the question title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType: type: string enum: - INTERNAL_CAREER_PAGE - EXTERNAL_CAREER_PAGE - LINKEDIN description: Type of job board title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems' title: RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201: type: object properties: data: $ref: '#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData' description: The created application interview plan stage record required: - data title: ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201 AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job location location: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation' description: Details for the location assigned to the job required: - id - location title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems ListTags-v2026-02-27RequestBadRequestError: type: object properties: path: type: string description: Request URL path errors: type: array items: $ref: '#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems' description: List of error objects timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - errors - timestamp - status_code title: ListTags-v2026-02-27RequestBadRequestError AtsJobsPostRequestBodyContentApplicationJsonSchemaData: type: object properties: title: type: string description: The job title team_ids: type: array items: type: string format: uuid description: Array of team IDs (at least one required) location_ids: type: array items: type: string format: uuid description: Array of location IDs department_ids: type: array items: type: string format: uuid description: Array of department IDs (optional) is_confidential: type: boolean default: false description: Whether the job posting is confidential interview_plan_id: type: string format: uuid description: Interview Plan ID must be a valid UUID employment_type_ids: type: array items: type: string format: uuid description: Array of employment type IDs (at least one required) richtext_description: type: - string - 'null' description: Rich text description of the job required: - title - team_ids - location_ids - employment_type_ids title: AtsJobsPostRequestBodyContentApplicationJsonSchemaData AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission: type: object properties: id: type: string format: uuid description: Identifier of the application form submission answers: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems' description: Array of question answers with parsed data required: - id - answers description: Application form submission data with mapped answers title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission ATS_retrieveAListOfAtsDepartments_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more departments available next_cursor: type: - string - 'null' description: Cursor for pagination to get the next set of results total_count: type: integer description: Total number of departments available required: - data - has_more - next_cursor - total_count title: ATS_retrieveAListOfAtsDepartments_Response_200 AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job employment type employment_type: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType' description: Employment type associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems ATS_retrieveAtsHiringMembers_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more items to fetch. next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: integer description: Total number of users title: ATS_retrieveAtsHiringMembers_Response_200 AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: Unique identifier for the application job: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob' description: Job details notes: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems' description: Array of notes associated with the application candidate: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate' description: Candidate details job_board: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard' - type: 'null' description: Job board details where the application originated created_at: type: string format: date-time description: Timestamp when the application was created created_by: type: - string - 'null' format: uuid description: Unique identifier for the HRIS organization user who created the application numeric_id: type: integer description: Numeric identifier for the application updated_at: type: string format: date-time description: Timestamp when the application was last updated job_posting: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting' - type: 'null' description: Job posting details referred_by: type: - string - 'null' format: uuid description: Unique identifier for the HRIS organization user who referred the candidate source_slug: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug' - type: 'null' description: Source of the application job_employment_type: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType' - type: 'null' description: Employment type associated with the application job_posting_publication: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication' - type: 'null' description: Job posting publication details referral_form_submission: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission' description: Referral form submission metadata moved_to_current_stage_at: type: string format: date-time description: Timestamp when the application moved to the current stage application_form_submission: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission' - type: 'null' description: Application form submission data with mapped answers job_posting_publication_state: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState' - type: 'null' description: Current state of the job posting publication application_job_criterias_matchings: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems' description: Array of job criteria matchings for the application all_application_interview_plan_stages: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems' description: Array of all application interview plan stages application_automation_rule_executions: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems' description: Array of automation rule executions for the application current_application_interview_plan_stage: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage' - type: 'null' description: Current interview plan stage for the application required: - id - job - notes - candidate - job_board - created_at - created_by - numeric_id - updated_at - job_posting - referred_by - source_slug - job_employment_type - job_posting_publication - referral_form_submission - moved_to_current_stage_at - job_posting_publication_state - application_job_criterias_matchings - all_application_interview_plan_stages - application_automation_rule_executions - current_application_interview_plan_stage title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems CreateAtsJobRequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems' title: CreateAtsJobRequestBadRequestError AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam: type: object properties: id: type: string format: uuid description: Unique identifier for the team name: type: string description: Team name description: Team associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState: type: object properties: id: type: string format: uuid description: Publication state row identifier. created_at: type: string format: date-time description: ISO 8601 timestamp when this state was recorded. created_by: type: - string - 'null' format: uuid description: HRIS organization user id who triggered or owns this state, when set. state_slug: $ref: '#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug' description: Publication lifecycle state (uppercase slug). error_message: type: - string - 'null' description: Error details when state is failed or otherwise errored; null if none. required: - id - created_at - created_by - state_slug - error_message description: Latest known publication state for this board. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems: type: object properties: id: type: string format: uuid description: Unique identifier for the application interview plan stage offers: type: array items: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems' description: Array of offers associated with this stage updated_at: type: - string - 'null' format: date-time description: Timestamp when the stage was last updated interview_plan_stage: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage' - type: 'null' description: Interview plan stage details required: - id - offers - updated_at - interview_plan_stage title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Error code field: type: string description: Request field related to the error, if applicable message: type: string description: Human-readable error message required: - code - field - message title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems CreateCandidateTags-v2026-02-27RequestBadRequestError: type: object properties: path: type: string description: Request URL path errors: type: array items: $ref: '#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems' description: List of error objects timestamp: type: string format: date-time description: Time when the error occurred status_code: type: integer description: HTTP status code required: - path - errors - timestamp - status_code title: CreateCandidateTags-v2026-02-27RequestBadRequestError AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation: type: object properties: id: type: string format: uuid description: Location identifier. name: type: string description: Display name of the location. description: Location entity for this association. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria: type: object properties: id: type: string format: uuid description: Unique identifier for the job criteria title: type: string description: Title of the job criteria description: type: string description: Description of the job criteria required: - id - title - description description: Job criteria details title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems: type: object properties: is_matched: $ref: '#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched' description: The matching state for the job criteria job_criteria_id: type: string format: uuid description: The job criteria ID to filter by required: - is_matched - job_criteria_id title: AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier for the candidate email: type: string format: email description: Candidate's email address pic_url: type: - string - 'null' description: URL of the candidate's profile picture last_name: type: string description: Candidate's last name created_at: type: string format: date-time description: Timestamp when the candidate was created first_name: type: string description: Candidate's first name numeric_id: type: number format: double description: Numeric identifier for the candidate updated_at: type: string format: date-time description: Timestamp when the candidate was last updated applications: type: array items: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems' phone_number: type: - string - 'null' description: Candidate's phone number candidate_tags: type: - array - 'null' items: $ref: '#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems' description: Tags associated with the candidate final_archivation_at: type: - string - 'null' format: date-time description: Timestamp of when the candidate was finally archived linkedin_profile_url: type: - string - 'null' description: URL of the candidate's LinkedIn profile total_applications_count: type: number format: double description: Total number of applications the candidate has title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment: type: object properties: id: type: string format: uuid description: Unique identifier for the department name: type: string description: Department name description: Department associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation: type: object properties: id: type: string format: uuid description: Unique identifier for the compensation job_id: type: string format: uuid description: Job ID associated with the compensation max_amount: type: - number - 'null' format: double description: Maximum compensation amount min_amount: type: - number - 'null' format: double description: Minimum compensation amount period_slug: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug' description: Compensation period currency_iso_code: type: string description: ISO code of the currency description: Current compensation details title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug: type: string enum: - LEAD - ACTIVE - COMPLETED description: Category type of the interview plan stage title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job team team: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam' description: Details for the team assigned to the job required: - id - team title: AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug: type: string enum: - PUBLISHED_BASIC - PUBLISHED_PREMIUM - UNPUBLISHED - EXPIRED - IN_PROGRESS - FAILED description: Publication lifecycle state (uppercase slug). title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems: type: object properties: id: type: string format: uuid description: Unique identifier for the offer email: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail' - type: 'null' description: Email message associated with the offer job_title: type: string description: Job title for the offer created_at: type: string format: date-time description: Timestamp when the offer was created start_date: type: string format: date-time description: Start date for the position updated_at: type: string format: date-time description: Timestamp when the offer was last updated country_code: type: string description: Country code (ISO 3166-1 alpha-2) attachment_id: type: - string - 'null' format: uuid description: Unique identifier for the offer attachment approval_rule_id: type: - string - 'null' format: uuid description: Unique identifier for the approval rule worker_type_enum: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum' description: Type of worker for the offer offer_status_enum: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum' description: Status of the offer approval_request_id: type: - string - 'null' format: uuid description: Unique identifier for the approval request compensation_amount: type: number format: double description: Compensation amount rejection_reason_id: type: - string - 'null' format: uuid description: Unique identifier for the rejection reason (if rejected) compensation_currency: type: string description: Currency code for compensation (ISO 4217) compensation_period_slug: oneOf: - $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug' - type: 'null' description: Compensation period application_interview_plan_stage_id: type: string format: uuid description: Unique identifier for the application interview plan stage required: - id - email - job_title - created_at - start_date - updated_at - country_code - attachment_id - approval_rule_id - worker_type_enum - offer_status_enum - approval_request_id - compensation_amount - rejection_reason_id - compensation_currency - compensation_period_slug - application_interview_plan_stage_id title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData: type: object properties: notes: type: - array - 'null' items: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems' description: Array of notes to attach to the application job_id: type: string format: uuid description: The ID of the job for this application candidate_id: type: string format: uuid description: The ID of the candidate applying job_posting_id: type: - string - 'null' format: uuid description: The ID of the job posting (optional) job_employment_type_id: type: string format: uuid description: The ID of the employment type for this job application_form_submission_data: type: - array - 'null' items: $ref: '#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems' description: Array of form submission answers required: - job_id - candidate_id - job_employment_type_id title: AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType: type: object properties: id: type: string format: uuid description: Employment type identifier. name: type: string description: Display name of the employment type. description: Employment type entity for this association. title: AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200: type: object properties: data: type: array items: $ref: '#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItems' has_more: type: boolean description: Indicates if there are more items to fetch. next_cursor: type: - string - 'null' description: Cursor for the next page of results total_count: type: number format: double description: Total number of offers title: ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200 CreateAtsApplication-v2026-01-01RequestBadRequestError: type: object properties: errors: type: array items: $ref: '#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems' title: CreateAtsApplication-v2026-01-01RequestBadRequestError AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier pic_url: type: - string - 'null' format: uri description: URL to the user's profile picture job_title: type: - string - 'null' description: User's job title last_name: type: string description: User's last name created_at: type: string format: date-time description: Creation timestamp first_name: type: string description: User's first name updated_at: type: - string - 'null' format: date-time description: Last update timestamp work_email: type: string format: email description: User's work email address hris_organization_user_id: type: string description: Unique identifier for the HRIS organization user title: AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job location location: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation' description: Location associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData: type: object properties: id: type: string format: uuid description: The unique identifier of the created application interview plan stage record created_at: type: string format: date-time description: The timestamp when the record was created updated_at: type: string format: date-time description: The timestamp when the record was last updated required: - id - created_at - updated_at description: The created application interview plan stage record title: AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType: type: object properties: id: type: string format: uuid description: Job employment type unique identifier employment_type: $ref: '#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType' required: - id - employment_type description: Employment type information for the job title: AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable explanation of the error title: AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState: type: object properties: id: type: string format: uuid description: Unique identifier for the publication state created_at: type: string format: date-time description: Timestamp when the publication was created created_by: type: - string - 'null' format: uuid description: User who created the publication state_slug: $ref: '#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug' description: Current publication state error_message: type: - string - 'null' description: Error message if publication failed required: - id - created_at - state_slug description: Current publication state details title: AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail : type: object properties: id: type: string format: uuid description: Unique identifier for the email message subject: type: string description: Email subject line body_html: type: string description: HTML body of the email from_string: type: string description: Email sender address recipients_cc: type: array items: type: string description: Array of CC recipient email addresses recipients_to: type: array items: type: string description: Array of recipient email addresses recipients_bcc: type: array items: type: string description: Array of BCC recipient email addresses required: - id - subject - body_html - from_string - recipients_cc - recipients_to - recipients_bcc description: Email message associated with the offer title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems : type: object properties: id: type: string format: uuid description: Unique identifier for the evaluation result group_id: type: integer description: Group ID for logical grouping of conditions operator_enum: $ref: '#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum' description: Comparison operator used in the evaluation comparison_value: type: string description: Value used for comparison in the evaluation is_condition_met: type: boolean description: Whether the condition was met form_builder_question_data_binding_id: type: string description: Data binding ID for the form builder question required: - id - group_id - operator_enum - comparison_value - is_condition_met - form_builder_question_data_binding_id title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems: type: object properties: code: type: string field: type: string message: type: string title: AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems: type: object properties: id: type: string format: uuid description: Unique identifier for the job team team: $ref: '#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam' description: Team associated with the job title: AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems AtsOffersGetResponsesContentApplicationJsonSchemaDataItems: type: object properties: id: type: string format: uuid description: Unique identifier email: oneOf: - $ref: '#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail' - type: 'null' description: Email details job_title: type: string description: Job title created_at: type: string format: date-time description: Timestamp when the offer was created start_date: type: string format: date description: Start date updated_at: type: string format: date-time description: Timestamp when the offer was last updated worker_type: $ref: '#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType' description: Worker type country_code: type: string format: country-code description: Country code offer_status: $ref: '#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus' description: Offer status attachment_id: type: - string - 'null' format: uuid description: Attachment identifier approval_rule_id: type: - string - 'null' format: uuid description: Approval rule identifier approval_request_id: type: - string - 'null' format: uuid description: Approval request identifier compensation_amount: type: number format: double description: Compensation amount rejection_reason_id: type: - string - 'null' format: uuid description: Rejection reason identifier compensation_currency: type: string description: Compensation currency application_interview_plan_stage_id: type: string format: uuid description: Application interview plan stage identifier title: AtsOffersGetResponsesContentApplicationJsonSchemaDataItems ? AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum : type: string enum: - EQUALS - NOT_EQUALS - CONTAINS - DOES_NOT_CONTAIN - IS_EMPTY - IS_NOT_EMPTY - GREATER_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL description: Comparison operator used in the evaluation title: AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum ? AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage : type: object properties: id: type: string format: uuid description: Unique identifier for the interview plan stage name: type: string description: Name of the interview plan stage description: type: - string - 'null' description: Description of the interview plan stage stage_order: type: number format: double description: Order of the stage in the interview plan default_type_slug: type: - string - 'null' description: Default type slug for the interview plan stage interview_plan_id: type: string format: uuid description: Unique identifier for the interview plan category_type_slug: type: string description: Category type slug for the interview plan stage title: AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage ATS_retrieveAtsJobPosting_Response_200: type: object properties: data: $ref: '#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData' title: ATS_retrieveAtsJobPosting_Response_200 securitySchemes: deelToken: type: http scheme: bearer description: "## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n" oauth2: type: http scheme: bearer description: Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/