Get group by ID

This endpoint enables you to get details about a specific group by its ID, the response will include the group name and creation date.

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

HTTP Request

GET https://api.superviz.com/groups/{id}

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

Name	Description
id	Required. The group ID.

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 that the request was successful. The response will be in JSON format and include the following fields:

Name	Type	Description
id	string	The group ID.
name	string	The group name.
createdAt	string	The group creation date.

If you want to get a list of participants in the group, you can use the get participants from a specific group endpoint.

Example:

{
  "id": "example-id",
  "name": "Red Team",
  "createdAt": "2021-05-30T21:23:00.000Z"
}