Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Query Parameters

fields
enum<string>[]

Field mask restricting the response to the listed User fields (id is always included). Comma-separated. When omitted, the lean default fields are returned (id, name, email, title, phoneNumber, deactivatedAt). Supported values: id, name, email, title, phoneNumber, deactivatedAt, country, jurisdiction, county, commissionNumber, notaryExpirationDate, notaryExpires, getImageUrls. The special value * returns every field. Requesting any notary value or getImageUrls (including via *) requires the reporting or manage permission.

Available options:
*,
id,
name,
email,
title,
phoneNumber,,
deactivatedAt,
country,
jurisdiction,
county,
commissionNumber,
notaryExpirationDate,,
notaryExpires,
getImageUrls,
isNotary
limit
integer
default:100

The number of items to return per page (default 100).

Required range: x >= 1
cursor
string

The cursor for fetching the next page of results.

owner
string
required

The owner (client group) whose users should be returned.

orderBy
enum<string>
default:name

The field to order the results by. Defaults to name.

Available options:
id,
name,
email,
title,
deactivatedAt
orderDirection
enum<string>
default:asc

The direction to order the results by. Defaults to asc.

Available options:
asc,
desc
filter
object

One or more fields and their values on which to filter results.

Response

A paginated list of users.

users
object[]
pagination
object