Skip to main content
GET
List Users

Authorizations

Authorization
string
header
required

Bearer token

X-Account-ID
string
header
required

Account ID

Query Parameters

email
string<email>

Filter by email (partial match)

role
enum<string>

Filter by role

Available options:
system_admin,
system_support,
admin,
support,
viewer,
organization_viewer
first_name
string

Filter by first name (partial match)

last_name
string

Filter by last name (partial match)

sort
string

Comma-separated fields to sort by (e.g., "email,created_at")

order
string

Comma-separated sort directions - ASC or DESC (e.g., "ASC,DESC")

limit
number
default:100

Number of items to return

Required range: 1 <= x <= 1000
offset
number
default:0

Number of items to skip

Required range: x >= 0
include_deleted
boolean
default:false

Include deleted in the results

filter
string

URL-encoded JSON AND/OR filter tree for complex queries. A node is a group {"and":[...]} / {"or":[...]} or a leaf — a bracket-notation string "field[operator]=value". Composes as an additional AND alongside the bracket-notation filters. Max nesting depth 3, max 50 conditions.

Response

Default Response

items
object[]
required
total
number
required

Total number of items available

limit
number
required

Number of items returned

offset
number
required

Number of items skipped