StaffFind available staff

Find available staff

Needs: Roster, Read

Finds active staff who are free to work a shift: not already rostered, not on leave, within their availability, not excluded by the clients, and meeting the clients' compliance requirements. Best matches come first (no notes, site support staff, nearest, fewest hours this week).

Note: Each person also has site_support_staff, notes and, for unavailable staff, reasons, when they apply. shift.site is left out unless site_id is sent. If more staff exist than can be checked, counts.not_checked and a note ask you to narrow the search with query or gender.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/staff/available?start=example_string&end=example_string&clients=%5B%22null%22%5D&site_id=123&query=example_string&gender=example_string&exclude_ref=example_string&include_unavailable=true&limit=42" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "shift": {
    "start": "2026-03-02 09:00",
    "end": "2026-03-02 13:00",
    "site": null
  },
  "available": [
    {
      "id": 31,
      "name": "Example Worker",
      "week_hours": 18.5,
      "distance_km": 4.2
    }
  ],
  "counts": {
    "staff_checked": 24,
    "available": 6,
    "unavailable": 18
  }
}
GET
/staff/available
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
startstring
Required

Shift start, YYYY-MM-DD HH:MM in the organisation's time.

query
endstring
Required

Shift end, YYYY-MM-DD HH:MM. Must be after start, and within 24 hours of it.

query
clientsarray

Up to 20 client ids, comma separated. Checks exclusions and the clients' compliance requirements.

query
site_idinteger

For a site shift. Site support staff are listed first.

query
querystring

Match a staff name.

query
genderstring

Match a gender.

query
exclude_refstring

When re-staffing an existing shift, its ref (such as a:123), so it is not counted as a clash.

query
include_unavailableboolean

Also list unavailable staff with reasons (up to 50).

query
limitinteger

How many available staff to return. Defaults to 10, up 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

startstring
Required

Shift start, YYYY-MM-DD HH:MM in the organisation's time.

endstring
Required

Shift end, YYYY-MM-DD HH:MM. Must be after start, and within 24 hours of it.

clientsarray

Up to 20 client ids, comma separated. Checks exclusions and the clients' compliance requirements.

site_idinteger

For a site shift. Site support staff are listed first.

querystring

Match a staff name.

genderstring

Match a gender.

exclude_refstring

When re-staffing an existing shift, its ref (such as a:123), so it is not counted as a clash.

include_unavailableboolean

Also list unavailable staff with reasons (up to 50).

limitinteger

How many available staff to return. Defaults to 10, up to 50.

Responses

OK