Registered users

This service returns the list of all the users registered for the challenge.

Since a user can register before the start date of a challenge, this service can help you partition your users between those who registered and those who did not. This can provide you with a simple way of notifying users who have not yet registered, or who have forgotten to register.

If you have your admin API key, you can try the API via this link.

List all registered users

GEThttps://service.drivequant.com/v3/drivekit/admin/challenges/{challengeId}/registered

Path parameters

challengeId*string

Unique identifier of the challenge

Query parameters

Header parameters

Response

200400401404

OK

Body

application/json

challengeIdstring

Unique identifier of the challenge

statusenum

Status of the users in the challenge

ALLRANKEDNOT_RANKED

countinteger

Total number of users with the given status

usersarray of UserInfo

List of users with the given status

Request

JavaScriptCurl

const response = await fetch('https://service.drivequant.com/v3/drivekit/admin/challenges/{challengeId}/registered', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "challengeId": "text",
  "status": "ALL",
  "users": [
    {
      "username": "text",
      "firstname": "text",
      "lastname": "text",
      "registerDate": "2024-04-30T13:34:22.233Z"
    }
  ]
}

---

Response

The table below summarizes the elements included in the RegisteredUsersResponse object.

Field	Type	Description
challengeId	string	Unique identifier of the challenge
status	string	Status of the users in the challenge Possible values: ALL, RANKED, NOT_RANKED
count	int	Total number of users with the given status
users	array[object]	List of users with the given status (see UserInfo)

UserInfo

The table below summarizes the elements included in the UserInfo object.

Field	Type	Description
username	string	Unique identifier of the user
firstname	string	First name of the user
lastname	string	Last name of the user
registerDate	string	Date at which the user entered the challenge Date format: YYYY-MM-dd’T’HH:mm:ss.SSSZ