GET
/
users

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

search
string

The search query string to use to search the User by their name or email.

Maximum length: 100
enabled
boolean

Set to true to return only enabled Users, false to return only disabled Users. Omit to return all Users.

role
enum<string>

Limit the returned Users to those in the supplied role. Separate multiple values with a comma. Omit to return all Users.

Available options:
admin,
collaborator,
billing_admin
page
integer
default: 1

The page of results to return.

Required range: 1 < x < 1000
count
integer
default: 10

The number of Users to return per-page between 1 and 100. The default is 10.

Required range: 1 < x < 100
sort_by
enum<string>

Sort the returned Users returned by name or role.

Available options:
name,
role
sort_order
enum<string>

Determines the sort order of the returned Users. Valid values are ascending or descending. Defaults to descending.

Available options:
ascending,
descending

Response

200 - application/json
status
enum<string>
Available options:
ok
info
object
pagination
object
zones
object[]