List Requests

get/v1/time_off/requests

Get the time off requests that workers in your company have made.

Query ParametersExpand Collapse

afterId: optional string

beforeId: optional string

endsBefore: optional string

a string to be decoded into a Date

endsOnOrAfter: 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

startsBefore: optional string

a string to be decoded into a Date

startsOnOrAfter: optional string

a string to be decoded into a Date

statuses: optional array of "pending" or "approved" or "denied"

Accepts one of the following:

"pending"

"approved"

"denied"

workerIds: optional array of string

ReturnsExpand Collapse

count: number

an integer

data: array of object { id, createdAt, endAt, 7 more }

id: string

createdAt: string

a string to be decoded into a Date

endAt: string

a string to be decoded into a Date

reason: string

requestedMinutes: number

startAt: string

a string to be decoded into a Date

status: "pending" or "approved" or "denied"

Accepts one of the following:

"pending"

"approved"

"denied"

timeOffPolicyId: string

a string starting with "top_"

timeZone: string

The time zone that the worker is requesting time off in.

workerId: string

The id of the worker.

hasMore: boolean

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

{
  "count": 0,
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "endAt": "endAt",
      "reason": "reason",
      "requestedMinutes": 0,
      "startAt": "startAt",
      "status": "pending",
      "timeOffPolicyId": "top_1234",
      "timeZone": "America/New_York",
      "workerId": "wrk_1234"
    }
  ],
  "hasMore": true
}

Returns Examples

{
  "count": 0,
  "data": [
    {
      "id": "id",
      "createdAt": "createdAt",
      "endAt": "endAt",
      "reason": "reason",
      "requestedMinutes": 0,
      "startAt": "startAt",
      "status": "pending",
      "timeOffPolicyId": "top_1234",
      "timeZone": "America/New_York",
      "workerId": "wrk_1234"
    }
  ],
  "hasMore": true
}