RosterGet a shift

Get a shift

Needs: Roster, Read

Returns one shift in full: times, address, clients, staff, services, segments, check-in and check-out, cancellation, recurrence, funding, group charge split and shift notes. Pay rates and costs are not included.

Note: The response also carries the shift's other stored details, such as its times and address. Group and site shifts add site and client_charge_split. Each segment lists its id, start, end, service, staff and its own shift_notes, and you use the segment ids to write per-segment notes.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/shifts/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": {
    "ref": "a:123",
    "type": "single",
    "status": "scheduled",
    "clients": [
      {
        "id": 12,
        "name": "Example Client"
      }
    ],
    "staff": [
      {
        "id": 31,
        "name": "Example Worker"
      }
    ],
    "services": [
      {
        "staff": "Example Worker",
        "service": "Assistance With Self-Care Activities - Standard - Weekday Daytime"
      }
    ],
    "segments": [],
    "shift_notes": []
  }
}
GET
/shifts/{ref}
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.
path
refstring
Required

The shift ref, such as a:123 or g:456.

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.

Path Parameters

refstring
Required

The shift ref, such as a:123 or g:456.

Responses

OK