People & profiles

Get Hris Change Requests

Lists change requests, optionally merged with time-off, with filters, sorting, pagination and pending count.

POSThttps://api.toku.com/hris/get-hris-change-requests

Required scope: people:read. It also needs banking:read, compensation:read, identity:read, time:read.

curl --request POST \
  --url 'https://api.toku.com/hris/get-hris-change-requests' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "PENDING",
  "category": "NEW_HIRE",
  "search": "string",
  "statuses": [
    "PENDING"
  ],
  "categories": [
    "NEW_HIRE"
  ],
  "orgIDs": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "orgTypes": [
    "CLIENT_ORGANIZATION"
  ],
  "countries": [
    "string"
  ],
  "employmentTypes": [
    "CONTRACTOR"
  ],
  "requestedByRoleInOrgIDs": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "terminationBatchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sortBy": "requestedAt",
  "sortDirection": "asc",
  "limit": 0,
  "offset": 0,
  "includeTimeOff": true
}'
200 response
{
  "requests": [],
  "total": 0,
  "pendingTotal": 0
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Body

application/json

statusstring

Available options: PENDING, APPROVED, REJECTED, CANCELLED, AUTO_APPROVED

categorystring

Available options: NEW_HIRE, PERSONAL_INFO, BUSINESS_ENTITY, EMERGENCY_CONTACT, COMPENSATION, EMPLOYMENT, TAX_INFO, TERMINATION, EMPLOYMENT_TYPE, WORK_AUTH, WALLET, BENEFITS_NETWORK, ADDITIONAL_COMPENSATION, STABLECOIN_ALLOCATION, PROVIDENT_FUND

searchstring

NOTE(ck): a .transform() rule is not mirrored here; TGA still enforces it

Allowed: at most 200 characters

statusesstring | any[]
categoriesstring | any | any[]

The stored categories, plus TIME_OFF (leave, merged into the feed at read time) and BASE_SALARY (the salary half of EMPLOYMENT), which the dashboard filters on.

orgIDsstring<uuid>[]

Allowed: at most 200 items

orgTypesstring[]
countriesstring[]

Allowed: at most 200 items

employmentTypesstring[]
requestedByRoleInOrgIDsstring<uuid>[]

Allowed: at most 200 items

terminationBatchIdstring<uuid>
sortBystring

Available options: requestedAt, employeeName, orgName, status, category

sortDirectionstring

Available options: asc, desc

limitinteger

Allowed: 1 to 200

offsetinteger

Allowed: 0 to 10000

includeTimeOffboolean

Response

200Successful response
requestsany[]
totalinteger
pendingTotalinteger
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits