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://nodeapi.superviz.com/groups/participant/{participantId} \
--header "Authorization: Bearer ${TOKEN}" \
--header "apikey: ${APIKEY}"
HTTP Request
GET https://nodeapi.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 Authorization Bearer token and the API Key. The following headers are required:
Name | Description |
---|---|
Authorization | Required. You must utilize the authentication token. |
apikey | Required. You must utilize the SuperViz Token that can be found on the developer page. By utilizing this key, we will define whether to get data from the developer or the production environment. |
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"
}
]
}