Retrieve all users

GET 
/users

Retrieve all users

Request

Header Parameters

sub-account stringrequired

Sub-account identifier required for all requests

Responses

200

List of all users

application/json

Schema

Schema

• Array [

user_id stringrequired

Unique identifier of the user

user_last_modified date-time

Time when the user profile was last modified

user_first_name string

First name of the user

user_last_name string

Last name of the user

user_birth_date date

Birth date of the user

user_birth_city string

Birth city of the user

user_birth_country string

Birth country of the user

user_phone string

Phone number of the user

user_email stringrequired

Email address of the user

user_role stringrequired

Possible values: [admin, user]

Role of the user

creator_id stringrequired

Identifier of the user who created this user profile

• ]

Example (from schema)

[
  {
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "user_last_modified": "2024-04-25T10:00:00Z",
    "user_first_name": "John",
    "user_last_name": "Doe",
    "user_birth_date": "1990-04-25",
    "user_birth_city": "New York",
    "user_birth_country": "USA",
    "user_phone": "+1234567890",
    "user_email": "user@example.com",
    "user_role": "admin",
    "creator_id": "Admin"
  }
]

Loading...