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 can access. Listing participants requires the read:participants scope.

Results are row-level access controlled. Unless the key holds the write:participants_admin scope, only the participants the key's tied staff member can access are returned — exactly as in the Diversity Sync app. A key with write:participants_admin sees every participant in the organisation.

The participant model

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

Properties

Name
object
Type
string
Description
The type of object. Always participant.
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). null if not set.
Name
status
Type
string
Description
Either active or archived.
Name
livemode
Type
boolean
Description
true when the object was returned by a live (ds_live_…) key, false in test mode.

GET/v1/participants

List participants

Returns a list of the active participants your key can access, ordered by name. Requires the read:participants scope.

The response is the uniform list envelope — an object of list, the url of the resource, a has_more boolean, and a data array of participant objects.

Optional attributes

Name
limit
Type
integer
Description
A limit on the number of objects to return, between 1 and 100. Defaults to 25.
Name
starting_after
Type
integer
Description
A cursor for pagination. Pass the id of the last participant from the previous page to fetch the next page. See pagination.

Request

GET

/v1/participants

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

Response

{
  "object": "list",
  "url": "/v1/participants",
  "has_more": true,
  "data": [
    {
      "object": "participant",
      "id": 1043,
      "name": "Riley Chen",
      "type": "NDIS",
      "status": "active",
      "livemode": true
    },
    {
      "object": "participant",
      "id": 1087,
      "name": "Sam Okafor",
      "type": null,
      "status": "active",
      "livemode": true
    }
  ]
}