StaffList leave

List leave

Needs: Staff, Read

Lists leave overlapping a period: staff, dates, days, type, status and reason, with counts by status and type. When the token also has Roster access, accepted and pending leave includes shifts_still_assigned, how many of that person's shifts fall inside the leave.

Note: At most 200 leave requests are returned. truncated is true when you hit that, so narrow the period or filters.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/leave?from=example_string&to=example_string&staff_id=123&status=example_string&leave_type=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "range": {
    "from": "2026-03-01",
    "to": "2026-03-31"
  },
  "summary": {
    "by_status": {
      "Pending": 1
    },
    "by_type": {
      "annual": 1
    },
    "staff_on_leave": 0
  },
  "data": [
    {
      "id": 8,
      "staff_id": 31,
      "staff": "Example Worker",
      "from": "2026-03-02",
      "to": "2026-03-06",
      "days": 5,
      "type": "annual",
      "status": "Pending",
      "reason": "Family holiday",
      "shifts_still_assigned": 2
    }
  ],
  "truncated": false
}
GET
/leave
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
query
fromstring
Required

First day of the period, YYYY-MM-DD.

query
tostring

Last day of the period, up to 366 days after from. Defaults to 30 days.

query
staff_idinteger

Only this staff member.

query
statusstring

Pending, Accepted or Rejected.

query
leave_typestring

For example annual, sick or personal.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Query Parameters

fromstring
Required

First day of the period, YYYY-MM-DD.

tostring

Last day of the period, up to 366 days after from. Defaults to 30 days.

staff_idinteger

Only this staff member.

statusstring

Pending, Accepted or Rejected.

leave_typestring

For example annual, sick or personal.

Responses

OK