v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Applications

Application Changes

List Application Changes

get/unified/ats/applications/{id}/changes

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:event_id,remote_event_id,created_at,effective_at,change_type,actor,new_values,unified_custom_fields

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

page_sizestring nullable

The number of results per page (default value is 25)

nextstring nullable

The unified cursor

created_afterstring date-time nullable

Use a string with a date to only select results created after that given date

change_type'application_status' | 'interview_stage' | 'rejected_reasons' | 'unmapped_value' nullable

Filter by the type of change that occurred to the application

Filter parameters for application changes (supports created_after and change_type)

{
  "created_after": "2020-01-01T00:00:00.000Z"
}

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 changes related to the application with the given identifier was retrieved.

nextstring nullable

Example response

{
  "data": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "created_at": "2024-01-15T10:30:00Z",
      "effective_at": "2024-01-15T10:30:00Z",
      "actor": {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
      },
      "change_type": {
        "value": "application_status"
      },
      "new_values": {
        "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
        "rejected_reason_ids": [
          "f223d7f6-908b-48f0-9237-b201c307f609"
        ],
        "application_status": {
          "value": "hired"
        }
      }
    }
  ]
}