Skip to main content
GET
List user directory

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Query Parameters

page
integer
default:1

Page number (starts at 1)

Required range: 0 < x <= 9007199254740991
rowsPerPage
integer
default:10

Number of items per page

Required range: 0 < x <= 100

Filters by name or email (case-insensitive).

Maximum string length: 100
status
enum<string>
default:ACTIVE

Status of the listed users. Default: ACTIVE.

Available options:
ACTIVE,
INACTIVE

Response

Page of the user directory

result
object[]
required

Users on the page

meta
object
required

Pagination metadata