Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
User Management

List Users

get/users/

Query parameters

accountboolean
activeboolean
excludestring[]

Fields to exclude from the response.

exclude_targetstring[]
exclude_teamstring[]
labelstring[]

A unique Base58 value identifying this object.

label_logical_operator'and' | 'or'

Logical operator to apply between user labels:
(Defaults to or)

  • and - and
  • or - or
lengthinteger

Number of results to return per page.

mfa_enabledboolean
no_accessboolean
orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

rolestring[]

A unique Base58 value identifying this object.

searchstring

A search term.

targetstring[]
teamstring[]

Response

countinteger

Total number of results.

page_totalinteger

Total number of pages.

pageinteger

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

lengthinteger

Number of results returned per page.

Example response

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10
}