List Users

get

https://bonus.ly/api/v1/users

Returns a paginated list of users in the authenticated user's company.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 100

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

skip

integer

≥ 0

Defaults to 0

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

string

Filter to users whose email contains this substring (case-insensitive).

sort

string

Sort by one of created_at, last_active_at, display_name, first_name, last_name, email, country, time_zone. Prefix with - for descending. Comma-separated for multi-key.

include_archived

boolean

Defaults to false

When true, include deactivated users.

show_financial_data

boolean

When true and the requester is an admin, include earning_balance / lifetime_earnings / giving_balance in each user.

user_mode

string

Filter by user_mode. String or comma-separated list. Valid values: normal, observer, receiver, benefactor, bot. The default index excludes bot users; pass user_mode=bot (or include it in a comma-separated list) to surface them.

Responses

200OK

400Bad Request — invalid limit, skip, or sort.

401Unauthorized — missing or invalid access token.