v3

latestSwagger 2.02026-08-067506752.0 MB

change

Return recent changes across an org, or for a particular person or job

get/v1/org/{orgId}/change

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

Scenario id

datestring date

Date to start from

untilDatestring date

Date to get changes through (exclusive)

typestring

Types of change to filter by

fieldsstring

Return changes that modify these fields

personIdstring

Person id to filter by

jobIdstring

Job id to filter by

includeBackfillboolean

Find and include first backfill if it exists

refsstring

References to filter by

qstring

Query to filter against

fromstring

Change id to start paginating from

limitinteger

Number of results to return

open'FILLED' | 'OPEN'

Whether the role is open or not

descboolean

Descending (default false)

scenarioOnlyboolean

Scenario only (exclude primary changes)

parentOnlyboolean

Parent changes only (exclude child changes)

excludeAtsRecruitingFieldsboolean

Whether to exclude ats recruiting fields. Only applies when fieldEntityTypeString is passed

includeStruckboolean

Deprecated parameter for backwards-compatibility (use statuses) - whether to include STRUCK and PROPOSED changes, or just ACTIVE changes

statusstring

Statuses to filter by

stripUpdatesboolean

Whether to strip returned update changes of update types that were not explicitly requested

formatstring

Data format to use; default is json, can also use json-extended or json-readable

fieldEntityTypesstring

Only return changes which set fields with these entity types

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "jobId": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "scenarioId": "588f7ee98f138b19220041a7",
      "mergeScenarioId": "588f7ee98f138b19220041a7",
      "parentChangeId": "588f7ee98f138b19220041a7",
      "priorStateChangeId": "588f7ee98f138b19220041a7",
      "personId": "588f7ee98f138b19220041a7",
      "otherJobId": "588f7ee98f138b19220041a7",
      "otherPersonId": "588f7ee98f138b19220041a7",
      "job": {
        "jobId": "588f7ee98f138b19220041a7",
        "orgId": "588f7ee98f138b19220041a7",
        "snapshotId": "588f7ee98f138b19220041a7",
        "title": "Senior Engineer",
        "relationships": [
          {
            "jobId": "5887a7718f138b6a2a0041a7"
          }
        ],
        "groupIds": [
          "588f7ee98f138b19220041a7"
        ],
        "personId": "588f7ee98f138b19220041a7",
        "backfillPersonId": "588f7ee98f138b19220041a7",
        "jobCodeId": "588f7ee98f138b19220041a7",
        "backfillByJobId": "588f7ee98f138b19220041a7",
        "upcoming": [
          {
            "id": "588f7ee98f138b19220041a7",
            "personId": "588f7ee98f138b19220041a7",
            "otherPersonId": "588f7ee98f138b19220041a7"
          }
        ],
        "scenarioId": "588f7ee98f138b19220041a7",
        "scenarioChangedId": "588f7ee98f138b19220041a7"
      },
      "otherJob": {
        "jobId": "588f7ee98f138b19220041a7",
        "orgId": "588f7ee98f138b19220041a7",
        "snapshotId": "588f7ee98f138b19220041a7",
        "title": "Senior Engineer",
        "relationships": [
          {
            "jobId": "5887a7718f138b6a2a0041a7"
          }
        ],
        "groupIds": [
          "588f7ee98f138b19220041a7"
        ],
        "personId": "588f7ee98f138b19220041a7",
        "backfillPersonId": "588f7ee98f138b19220041a7",
        "jobCodeId": "588f7ee98f138b19220041a7",
        "backfillByJobId": "588f7ee98f138b19220041a7",
        "upcoming": [
          {
            "id": "588f7ee98f138b19220041a7",
            "personId": "588f7ee98f138b19220041a7",
            "otherPersonId": "588f7ee98f138b19220041a7"
          }
        ],
        "scenarioId": "588f7ee98f138b19220041a7",
        "scenarioChangedId": "588f7ee98f138b19220041a7"
      },
      "formId": "588f7ee98f138b19220041a7",
      "formResponseId": "588f7ee98f138b19220041a7",
      "assessmentId": "588f7ee98f138b19220041a7",
      "update": {
        "addRelationships": [
          {
            "jobId": "5887a7718f138b6a2a0041a7"
          }
        ],
        "removeRelationships": [
          {
            "jobId": "5887a7718f138b6a2a0041a7"
          }
        ],
        "addGroupIds": [
          "588f7ee98f138b19220041a7"
        ],
        "removeGroupIds": [
          "588f7ee98f138b19220041a7"
        ],
        "grant": {
          "stock": "GOOG"
        },
        "backfillPersonId": "588f7ee98f138b19220041a7",
        "jobCodeId": "588f7ee98f138b19220041a7"
      },
      "upcoming": {
        "id": "588f7ee98f138b19220041a7",
        "personId": "588f7ee98f138b19220041a7",
        "otherPersonId": "588f7ee98f138b19220041a7"
      },
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "mergeId": "588f7ee98f138b19220041a7",
      "createAt": "2017-01-24T13:57:52Z",
      "updateAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "approvalId": "588f7ee98f138b19220041a7",
      "approvalNote": "Not acceptable"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}