List Application Changes

curl --request GET \
  --url https://api.stackone.com/unified/ats/applications/{id}/changes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next": "<string>",
  "data": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "new_values": {
        "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
        "rejected_reason_ids": [
          "f223d7f6-908b-48f0-9237-b201c307f609"
        ],
        "application_status": {
          "value": "hired",
          "source_value": "Hired"
        }
      },
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "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",
        "source_value": "StatusChange"
      }
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

ats

applications

{id}

changes

List Application Changes

curl --request GET \
  --url https://api.stackone.com/unified/ats/applications/{id}/changes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next": "<string>",
  "data": [
    {
      "created_at": "2024-01-15T10:30:00Z",
      "new_values": {
        "interview_stage_id": "18bcbb1b-3cbc-4198-a999-460861d19480",
        "rejected_reason_ids": [
          "f223d7f6-908b-48f0-9237-b201c307f609"
        ],
        "application_status": {
          "value": "hired",
          "source_value": "Hired"
        }
      },
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "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",
        "source_value": "StatusChange"
      }
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

This endpoint is currently in beta and subject to change before full release.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

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

proxy

object

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

fields

string | null

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

Example:

"event_id,remote_event_id,created_at,effective_at,change_type,actor,new_values,unified_custom_fields"

page_size

string | null

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

string | null

The unified cursor

filter

object

Filter parameters for application changes (supports created_after and change_type)

Show child attributes

filter[created_after]

string<date-time> | null

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

Example:

"2020-01-01T00:00:00.000Z"

filter[change_type]

enum<string> | null

Filter by the type of change that occurred to the application

Available options:

application_status,

interview_stage,

rejected_reasons,

unmapped_value

Response

The changes related to the application with the given identifier was retrieved.

string | null

data

object[] | null

Show child attributes

data.created_at

string<date-time>

required

Timestamp when the change was created

Example:

"2024-01-15T10:30:00Z"

data.new_values

object

required

The new values for changed application properties. Only includes fields that commonly change over the application lifecycle.

Show child attributes

data.new_values.interview_stage_id

string | null

deprecated

Unique identifier of the interview stage

Example:

"18bcbb1b-3cbc-4198-a999-460861d19480"

data.new_values.rejected_reason_ids

string[] | null

Unique identifiers of the rejection reasons

Example:

["f223d7f6-908b-48f0-9237-b201c307f609"]

data.new_values.application_status

object

Show child attributes

data.new_values.application_status.value

enum<string> | null

The status of the application.

Available options:

active,

assessment,

background_check,

converted,

declined_by_candidate,

hired,

interview,

lead,

offer,

reference_check,

rejected,

review,

screen,

new,

onboarding,

created,

accepted,

short_list,

approved,

unmapped_value,

Example:

"hired"

data.new_values.application_status.source_value

The source value of the application status.

Example:

"Hired"

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.effective_at

string<date-time> | null

Timestamp when the change became effective

Example:

"2024-01-15T10:30:00Z"

data.actor

object

The actor who made the change

Show child attributes

data.actor.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.actor.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.change_type

object

The type of change that occurred to the application

Show child attributes

data.change_type.value

enum<string> | null

The type of change that occurred to the application

Available options:

application_status,

interview_stage,

rejected_reasons,

unmapped_value,

Example:

"application_status"

data.change_type.source_value

The source value of the change type

Example:

"StatusChange"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

List Application Scorecards List Application Notes

⌘I

Getting Started

Use Cases

API Reference

List Application Changes

Authorizations

Headers

Path Parameters

Query Parameters

Response