List Balances

get/v1/time_off/balances

Get worker remaining time-off balances.

Query ParametersExpand Collapse

afterId: optional string

beforeId: optional string

endDate: optional string

a string to be decoded into a Date

limit: optional string

a number less than or equal to 100

policyIds: optional array of string

startDate: optional string

a string to be decoded into a Date

workerIds: optional array of string

ReturnsExpand Collapse

count: number

an integer

data: array of object { id, accruedLocked, accruedUnlocked, 5 more }

id: string

accruedLocked: number

accruedUnlocked: number

available: number

holds: number

legacyWorkerId: string

policyId: string

a string starting with "top_"

used: number

hasMore: boolean

curl https://api.joinwarp.com/v1/time_off/balances \
    -H "x-api-key: $WARP_API_KEY"

{
  "count": 0,
  "data": [
    {
      "id": "id",
      "accruedLocked": 0,
      "accruedUnlocked": 0,
      "available": 0,
      "holds": 0,
      "legacyWorkerId": "legacyWorkerId",
      "policyId": "top_1234",
      "used": 0
    }
  ],
  "hasMore": true
}

Returns Examples

{
  "count": 0,
  "data": [
    {
      "id": "id",
      "accruedLocked": 0,
      "accruedUnlocked": 0,
      "available": 0,
      "holds": 0,
      "legacyWorkerId": "legacyWorkerId",
      "policyId": "top_1234",
      "used": 0
    }
  ],
  "hasMore": true
}