Skip to main content
GET
Get All Users

Authorizations

X-Api-Key
string
header
required

Query Parameters

query
string

Filter users by name or email.

limit
integer

Maximum number of users to return.

Response

OK

id
number
required
Example:

1304

name
string
required
Example:

"User Name"

role
enum<string>
required
Available options:
admin,
supervisor,
member,
member_limited
Example:

"admin"

status
enum<string>
required
Available options:
active,
invited,
pending,
removed
Example:

"active"

headline
string | null
Example:

"CEO"

avatarUrl
string | null
phone
string | null
capacity
integer | null

Weekly capacity in seconds.

avatarUrlLarge
string | null