v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Jobs

Get Job

get/unified/ats/jobs/{id}

Path parameters

idstring required

Query parameters

rawboolean nullable

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

proxyobject nullable

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fieldsstring nullable

Example:id,remote_id,code,title,description,status,job_status,department_ids,remote_department_ids,location_ids,remote_location_ids,hiring_team,interview_stages,confidential,custom_fields,created_at,updated_at,unified_custom_fields

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

expandstring nullable

Example:job_postings,interview_stages

The comma separated list of fields that will be expanded in the response

includestring nullable

Example:custom_fields

The comma separated list of fields that will be included in the response

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Response

The job with the given identifier was retrieved.

Example response

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "code": "184919",
    "title": "Software Engineer",
    "description": "Responsible for identifying business requirements",
    "status": "archived",
    "job_status": {
      "value": "published"
    },
    "department_ids": [
      "308570",
      "308571",
      "308572"
    ],
    "location_ids": [
      "668570",
      "678571",
      "688572"
    ],
    "remote_location_ids": [
      "668570",
      "678571",
      "688572"
    ],
    "hiring_team": [
      {
        "user_id": "123456",
        "remote_user_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@gmail.com",
        "role": "Software Engineer"
      }
    ],
    "interview_stages": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "unified_custom_fields": {
          "my_project_custom_field_1": "REF-1236",
          "my_project_custom_field_2": "some other value"
        },
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "custom_fields": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Training Completion Status",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  }
}