Sign in
dashboard

Get list of users name information

Changed on

Returns id, name, dni, itinerary, status, role, deletedAt and created at information of users.

get/api/v1/dashboard/users

Request

  • The document declares no server URL.
  • Auth: API key in cookie authToken

Query parameters

itinerarySlugstring
Example:frontend-angular

Slug of the itinerary for which to retrieve users by itineraries

status'ACTIVE' | 'PENDING' | 'BLOCKED' | 'DELETED'

Status to filter by

startDatestring date nullable

Start date to filter users by, format YYYY-MM-DD

endDatestring date nullable

End date to filter users by, format YYYY-MM-DD

namestring
Example:John Doe

Partial or full name to filter the users by

dnistring

Partial or full dni to filter the users by

role'ADMIN' | 'MENTOR' | 'REGISTERED'

Role to filter by

Response

Token is valid and user information is returned.

idstring required
dnistring required
namestring required
status'ACTIVE' | 'PENDING' | 'BLOCKED' required
role'ADMIN' | 'MENTOR' | 'REGISTERED' required
createdAtstring required
itineraryNamestring required
deletedAtstring nullable required

Example response

[
  {
    "id": "b6z2od3ut12qs0ilem6njgjp",
    "name": "John Doe",
    "createdAt": "21/02/2024",
    "itineraryName": "Frontend Angular"
  }
]

Changes