Skip to main content
GET
/
users
Retrieve a list of users
curl --request GET \
  --url http://localhost:{port}/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "d4add56e-c345-4ac9-b392-7a890a60559a",
    "identifier": "ben",
    "name": "Benjamin Zhang",
    "email": "[email protected]",
    "user_type": "saas_admin",
    "status": "active",
    "created_at": "2023-05-06T00:00:00Z",
    "updated_at": "2023-05-06T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  },
  {
    "id": "e513d2c8-319e-4bc3-898b-3933ab39b452",
    "identifier": "john",
    "name": "John Jiang",
    "email": "[email protected]",
    "user_type": "saas_user",
    "status": "onboarding",
    "created_at": "2023-05-06T00:00:00Z",
    "updated_at": "2023-05-06T00:00:00Z",
    "created_by": "98d91cd7-860d-4869-937a-5af32eff2f4a",
    "updated_by": "98d91cd7-860d-4869-937a-5af32eff2f4a"
  }
]

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-API-Version
enum<string>
default:v1

Your API version

Available options:
v1
​
Content-Type
enum<string>
Available options:
application/json,
application/xml,
application/x-www-form-urlencoded,
application/octet-stream,
application/pdf,
text/plain,
text/html,
multipart/form-data

Query Parameters

​
sort_by
string

The field to sort by.

​
sort_order
enum<string>

Order of sorting (asc or desc) Sort order:

  • asc - Ascending, from A to Z
  • desc - Descending, from Z to A
Available options:
asc,
desc
​
id
string

Filter data by its id, require metadata permissions, REQUIRE metadata permissions

​
created_by
string

Filter data by the user who created them, REQUIRE metadata permissions

​
updated_by
string

Filter data by the user who last updated them, REQUIRE metadata permissions

​
user_type
string

The type of user to filter by.

​
status
string

Filter user by status.

​
created_at_from
string<date-time>

Filter data that were created after this date.

​
created_at_to
string<date-time>

Filter data that were created before this date.

​
updated_at_from
string<date-time>

Filter data that were updated after this date.

​
updated_at_to
string<date-time>

Filter data that were updated before this date.

​
search
string

Fuzzy match data by id, email, name or description.

​
page
integer

The page number to retrieve.

Required range: x >= 1
​
page_size
integer

The number of items to retrieve per page.

Required range: 1 <= x <= 100

Response

Success

​
id
string<uuid>
required
Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
identifier
string
required
Example:

"ben"

​
name
string
required
Example:

"Benjamin Zhang"

​
email
string<email>
required
​
user_type
enum<string>
required
Available options:
saas_admin,
saas_user,
saas_user_client
Example:

"saas_user"

​
status
enum<string>
required
Available options:
active,
onboarding,
inactive,
suspended,
risky
Example:

"active"

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
created_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"

​
updated_by
string<uuid>

REQUIRE metadata permissions

Example:

"98d91cd7-860d-4869-937a-5af32eff2f4a"