Get a participant's group list

This endpoint enables you to get a group list of specific participants.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --location --request GET https://api.superviz.com/groups/participant/{participantId} \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}"

HTTP Request

GET https://api.superviz.com/groups/participant/{participantId}

In the request, you will need to send in the path following field:

Name	Description
participantId	Required. The ID of the participant.

Headers

When using this endpoint, you need to provide the Client ID and Secret Key. The following headers are required:

Name	Description
client_id	Required. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secret	Required. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Response

Status code 200 will indicate a successful response containing a list of groups from the specific participant. The response will be in JSON format, following the pagination guide for SuperViz REST API, and include the following fields:

Name	Type	Description
group[]	array	The list of groups.
group[].id	string	The ID of the group.
group[].name	string	The name of the group.
group[].createdAt	string	The date and time when the group was created.

Example:

{
  "pagination": {
    "page": 1,
    "totalPages": 10,
    "limit": 10,
    "total": 100
  },
  "data": [
    {
      "id": "example-id",
      "name": "John Doe",
      "createdAt": "2021-05-30T21:23:00.000Z"
    }
  ]
}