Participants

Participants are the people your organisation supports. On this page you'll find the participant model and the endpoint for listing the active participants your key's staff member is allowed to access. Listing participants requires the read:participants scope.

Results respect participant access control. Unless the key holds the write:participants_admin scope, only participants the key's staff member can access are returned — exactly as in the Diversity Sync app.

The participant model

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

Properties

Name
id
Type
integer
Description
Unique identifier for the participant within your organisation.
Name
name
Type
string
Description
The participant's full name.
Name
type
Type
string
Description
The participant's organisation type (e.g. NDIS).
Name
status
Type
string
Description
Either active or archived.

GET/v1/participants

List participants

Returns a paginated list of the active participants your key's staff member can access, ordered by name. Requires the read:participants 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/participants

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

Response

{
  "page": 1,
  "pageSize": 25,
  "participants": [
    {
      "id": 1043,
      "name": "Riley Chen",
      "type": "NDIS",
      "status": "active"
    }
  ]
}