List Users

limit

number

Defaults to 20

Number of users to retrieve (min: 1, max: 100)

skip

number

Number of users to skip (for pagination, min: 0)

email

string

Example: blumbergh%40initech.com

externalId

string

Example: 'abc123'

sort

string

Options: created_at, last_active_at, display_name, first_name, last_name, email, country, time_zone. Default order is 'Ascending', prefix an option with '-' to specify 'Descending'

include_archived

boolean

Defaults to false

Include archived/deactivated users

show_financial_data

boolean

Whether or not to include financial data (giving balance, etc.) (admin only)

user_mode

string

comma separated list of user_modes (valid user modes are normal, observer, receiver, benefactor, bot)

200OK