Skip to main content
GET
List all Users

Authorizations

Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

x-project-id
string
header
required

Workspace UID required to identify the workspace.

Query Parameters

role
string

To search for specific users by role: 'user', 'external', 'admin', and 'owner'.

search_term
string

A string used to specify the keyword or phrase to search for within the Users, like an email or a User's name.

retrieve_accounts
boolean
default:true

Setting this to TRUE will retrieve the Accounts data, but please note it may take longer to compute.

page
integer
default:0

To iterate through the list of Users.

Response

200 - application/json

Successful Response

users
object[]
required

A list of users.

nbr_users
integer
required

The total number of users.

Example:

37

limit
integer
required

The number of users per page.

Example:

30

pages
integer
required

The total number of pages available.

Example:

2

paging
object