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

get

Authorizations

Path parameters

challengeIdstringRequired

Unique identifier of the challenge

Query parameters

statusstring · enumOptional

Status of the users in the challenge

Default: ALLAvailable options:

Header parameters

DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Responses

application/json

objectOptional

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /v3/drivekit/admin/challenges/{challengeId}/registered HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Accept: */*

{
  "challengeId": "text",
  "status": "ALL",
  "count": 1,
  "users": [
    {
      "username": "text",
      "firstname": "text",
      "lastname": "text",
      "registerDate": "2025-04-21T06:19:06.740Z"
    }
  ]
}

---

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