RosterSCHADS warnings

SCHADS warnings

Needs: Roster, Read

Returns SCHADS award warnings as the roster shows them: short shifts, overtime and weekly hours, daily hours, broken shifts and rest between shifts. Only shifts that have warnings are returned. Use it after creating or changing shifts, or to review a week.

Note: At most 100 shifts with warnings are listed. A note asks you to narrow the range or filters when there are more.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/shifts/warnings?refs=%5B%22null%22%5D&from=example_string&to=example_string&staff_id=123&client_id=123&site_id=123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "shifts_checked": 64,
  "shifts_with_warnings": 1,
  "data": [
    {
      "ref": "a:123",
      "start": "2026-03-02 09:00",
      "end": "2026-03-02 11:00",
      "warnings": [
        "..."
      ]
    }
  ]
}
GET
/shifts/warnings
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
refsarray

Check these shifts (up to 100), comma separated.

query
fromstring

Or check a period, YYYY-MM-DD. Needed when refs is not sent.

query
tostring

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

query
staff_idinteger

Only this staff member.

query
client_idinteger

Only this client.

query
site_idinteger

Only this site.

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

refsarray

Check these shifts (up to 100), comma separated.

fromstring

Or check a period, YYYY-MM-DD. Needed when refs is not sent.

tostring

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

staff_idinteger

Only this staff member.

client_idinteger

Only this client.

site_idinteger

Only this site.

Responses

OK