Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

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

Query Parameters

filter
string

Filters results using an expression. Combine comparisons with AND, OR, NOT, and parentheses. Supported fields: id, email. Strings, integers, and timestamps support =, !=, <, <=, >, and >=; UUIDs and booleans support = and !=.

order_by
string

Orders results by a comma-separated list of fields. Fields sort ascending by default; append asc or desc to set a direction. Supported fields: id, email, name. Default: id asc. Unless id is explicitly included, id asc is appended as a deterministic tie-breaker.

Example:

"email,name desc"

page_size
integer
default:50

Maximum number of records to return. Defaults to 50; values above 1000 are reduced to 1000. May change between pages.

Required range: x >= 1
page_token
string

Continues after the last record of a previous page. Pass meta.next_page_token from that response and repeat the same filtering and ordering arguments. Cannot be combined with a non-zero skip.

skip
integer
default:0

Number of records to skip from the start of the collection, to jump to a position without a page_token. The response still returns meta.next_page_token for continuing from there. Cannot be combined with a non-empty page_token.

Required range: x >= 0

Response

OK

data
object[]
required
meta
object
required