Skip to main content
GET
List users

Autorizações

api_access_token
string
header
obrigatório

API access token authentication

Cabeçalhos

account-id
string<uuid>
obrigatório

Account ID (required)

Parâmetros de consulta

page
integer

Page number

per_page
integer

Items per page

Search by name or email

role
enum<string>

Filter by role:

  • administrator
  • agent
Opções disponíveis:
administrator,
agent
status
enum<string>

Filter by status

Opções disponíveis:
active,
inactive

Resposta

Users retrieved successfully

success
boolean
Exemplo:

true

data
object[]
meta
object
message
string