SitesList sites

List sites

Needs: Roster, Read

Lists sites (houses or locations for site shifts) with their status, address, capacity, manager and participants. Participants are the clients a site shift can include. Sorted by name, up to 50 sites.

Note: Fields that have no value, such as tags or manager, are left out.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/sites?query=example_string&status=example_string&include_staff=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": 4,
      "name": "Example House",
      "type": "Supported Independent Living",
      "status": "Active",
      "address": "10 Example Rd, Perth WA 6000",
      "client_capacity": 4,
      "manager": "Example Manager",
      "participants": [
        {
          "id": 12,
          "name": "Example Client"
        }
      ],
      "support_staff": [
        {
          "id": 31,
          "name": "Example Worker"
        }
      ],
      "admin_staff": [
        {
          "id": 40,
          "name": "Example Admin"
        }
      ]
    }
  ]
}
GET
/sites
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
querystring

Match a site name.

query
statusstring

Exact status match, such as Active.

query
include_staffboolean

Also include support_staff and admin_staff.

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

querystring

Match a site name.

statusstring

Exact status match, such as Active.

include_staffboolean

Also include support_staff and admin_staff.

Responses

OK