Participant groups

Participant groups let your organisation group participants together (for example by house, program, or cohort). This is a small reference lookup, so the full set is returned in one response — there's no pagination. Requires the read:participant_groups scope.

The participant group model

Properties

Name
id
Type
integer
Description
Unique identifier for the group within your organisation.
Name
name
Type
string
Description
The group's name.

GET/v1/participant-groups

List participant groups

Returns every participant group in your organisation, ordered by name. Requires the read:participant_groups scope.

Request

GET

/v1/participant-groups

curl https://api.diversitysync.com/v1/participant-groups \
  -H "Authorization: Bearer {access_token}"

Response

{
  "groups": [
    { "id": 4, "name": "Lakeside Cohort" },
    { "id": 9, "name": "Day Program" }
  ]
}