Skip to main content
GET
/
api
/
v2
/
users
List Users
curl --request GET \
  --url https://api.example.com/api/v2/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email_address": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "account_role": "<string>",
      "is_deleted": true,
      "profile_picture": null,
      "profile_color": null
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include_deleted
boolean | null

Response

200 - application/json

UsersListResponse(users: List[server.api_routes.users_api_v2.UserResponse])

users
UserResponse · object[]
required