change

Return enriched compensation history rows (one row per comp change), in descending date order

get/v1/org/{orgId}/change/compensation-history

Request

  • Base URL
    https://localhost
  • URL
    https://localhost/v1/org/{orgId}/change/compensation-history
  • Auth
    none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

startDatestring date

Date to start from

endDatestring date

Date to get changes through (inclusive)

qstring

Filter query string

frominteger

Cursor for paginating from a previous response

limitinteger

Number of results to return

formatstring

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

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "changeId": "588f7ee98f138b19220041a7",
      "personId": "588f7ee98f138b19220041a7",
      "jobId": "588f7ee98f138b19220041a7"
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 26 revisions of this API.