Skip to main content
POST
ListUsers

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
pageSize
integer<int32>
Required range: 0 <= x <= 200
pageToken
string
query
string

Case-insensitive substring of the email or full name, applied before paging.

Maximum string length: 256
status
enum<string>
Available options:
USER_STATUS_UNSPECIFIED,
USER_STATUS_ACTIVE,
USER_STATUS_DISABLED,
USER_STATUS_DELETED
order
enum<string>
Available options:
USER_ORDER_UNSPECIFIED,
USER_ORDER_NAME_ASCENDING,
USER_ORDER_NAME_DESCENDING,
USER_ORDER_CREATED_ASCENDING,
USER_ORDER_CREATED_DESCENDING

Response

Success

users
User · object[]
nextPageToken
string