Skip to main content
GET
List users

Authorizations

api_access_token
string
header
required

API access token authentication

Headers

account-id
string<uuid>
required

Account ID (required)

Query Parameters

page
integer

Page number

per_page
integer

Items per page

Search by name or email

role
enum<string>

Filter by role:

  • administrator
  • agent
Available options:
administrator,
agent
status
enum<string>

Filter by status

Available options:
active,
inactive

Response

Users retrieved successfully

success
boolean
Example:

true

data
object[]
meta
object
message
string