RosterList shifts

List shifts

Needs: Roster, Read

Lists shifts (single-client appointments and group or site shifts) in a date range as a compact summary, sorted by start time. Use the shift's ref with the details endpoint for the full record.

Note: ref is a: plus the id for a single-client shift, and g: plus the id for a group or site shift. type is single or group. status is draft, scheduled, in_progress, completed or cancelled. staff is unassigned when nobody is on the shift, and group shifts also carry the site name.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/shifts?from=example_string&to=example_string&client_id=123&staff_id=123&site_id=123&unassigned_only=true&include_cancelled=true&page=25&per_page=25" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "range": {
    "from": "2026-03-02",
    "to": "2026-03-08"
  },
  "data": [
    {
      "ref": "a:123",
      "type": "single",
      "start": "2026-03-02 09:00:00",
      "end": "2026-03-02 13:00:00",
      "service": "Assistance With Self-Care Activities - Standard - Weekday Daytime",
      "clients": [
        "Example Client"
      ],
      "staff": [
        "Example Worker"
      ],
      "status": "scheduled"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "last_page": 1
  }
}
GET
/shifts
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

Start date, YYYY-MM-DD.

query
tostring

End date, up to 31 days after from. Defaults to 7 days.

query
client_idinteger

Only shifts for this client, including group shifts they attend.

query
staff_idinteger

Only shifts assigned to this staff member.

query
site_idinteger

Only shifts at this site.

query
unassigned_onlyboolean

Only shifts with no staff, or in the shift pool.

query
include_cancelledboolean

Include cancelled shifts. Defaults to false.

query
pageinteger

Page number, 1 or greater.

query
per_pageinteger

1 to 100. Defaults to 50.

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

Start date, YYYY-MM-DD.

tostring

End date, up to 31 days after from. Defaults to 7 days.

client_idinteger

Only shifts for this client, including group shifts they attend.

staff_idinteger

Only shifts assigned to this staff member.

site_idinteger

Only shifts at this site.

unassigned_onlyboolean

Only shifts with no staff, or in the shift pool.

include_cancelledboolean

Include cancelled shifts. Defaults to false.

pageinteger

Page number, 1 or greater.

per_pageinteger

1 to 100. Defaults to 50.

Responses

OK