Get archived participants
This endpoint enables you to list the archived 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/participants/archived \
--header "Authorization: Bearer ${TOKEN}" \
--header "apikey: ${APIKEY}"
HTTP Request
GET https://nodeapi.superviz.com/participants/archived
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 that list of archived participants. 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:
{
"pagination": {
"page": 1,
"totalPages": 10,
"limit": 10,
"total": 100
},
"data": [
{
"id": "example-id",
"name": "John Doe",
"email": "john@doe.com",
"avatar": "https://example.com/avatar.png",
"createdAt": "2021-05-30T21:23:00.000Z"
}
]
}