Get group participants

This endpoint enables you to get a participant list of specific groups.

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/participants/{groupId} \
    --header "client_id: ${YOUR CLIENT_ID}" \
    --header "secret: ${YOUR SECRET}"

HTTP Request

GET https://api.superviz.com/groups/participants/{groupId}

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

Name	Description
groupId	Required. The ID of the group.

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 with the participant list of the specific group. The response will be in JSON format, following the pagination guide for SuperViz REST API, and include the following fields:

Name	Type	Description
participant[]	array	The list of participants.
participant[].id	string	The ID of the participant.
participant[].name	string	The name of the participant.
participant[].email	string	The email of the participant.
participant[].avatar	string	The avatar of the participant.
participant[].createdAt	string	The date and time of the participant's creation.

Example:

[
  {
    "id": "example-id",
    "name": "John Doe",
    "email": "john@doe.com",
    "avatar": "https://example.com/avatar.png",
    "createdAt": "2021-05-30T21:23:00.000Z"
  }
]