API ReferenceUsers

List Users

Returns a paginated list of activated users in the authenticated business. Results are sorted by first name, then last name, ascending. Users with internal platform roles (SUPER_ADMIN, SUPER_MANAGER) are automatically excluded from results.

Requires scope: users:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, email, firstName, lastName, phoneNumber, activated, createdAt. Default order (when no sort is supplied): firstName,asc then lastName,asc.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error