Sites

Sites are the locations and programs your organisation operates. This endpoint returns your organisation's active sites. Listing sites requires the read:sites scope.

The site model

The site model contains the core details of a site in your organisation.

Properties

Name
id
Type
integer
Description
Unique identifier for the site within your organisation.
Name
name
Type
string
Description
The site's name.
Name
address
Type
string
Description
The site's address, if set.
Name
type
Type
string
Description
The site's program or type, if set.
Name
status
Type
string
Description
Either active or archived.

GET/v1/sites

List sites

Returns a paginated list of the active sites in your organisation, ordered by name. Requires the read:sites scope.

Optional attributes

Name
page
Type
integer
Description
The page to return, starting at 1. Defaults to 1.
Name
pageSize
Type
integer
Description
The number of items per page (1–100). Defaults to 25.

Request

GET

/v1/sites

curl -G https://api.diversitysync.com/v1/sites \
  -H "Authorization: Bearer {access_token}" \
  -d pageSize=25

Response

{
  "page": 1,
  "pageSize": 25,
  "sites": [
    {
      "id": 37,
      "name": "Riverside House",
      "address": "12 Riverside Drive, Brisbane QLD 4000",
      "type": "Supported Independent Living",
      "status": "active"
    }
  ]
}