List users

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

searchstring

Search users by name or email

idstring

Filter by user UUID

emailstring

Filter by exact email address

business_idstring

Filter by business UUID. Returns users in that business only.

firm_idstring

Filter by advisory firm UUID. Firm-wide: all users in that firm.

cursorstring

Cursor for pagination

limitinteger

Pagination limit

directionstringdefault: next

Pagination direction: 'next' or 'prev'

include_total_countbooleandefault: False

Whether to include total count (expensive - avoid if possible)

sort_bystring

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descendingbooleandefault: True

Sort direction: true for descending (newest/largest first), false for ascending

Headers

x-firm-idstring

Advisory firm UUID for firm-wide view. Same as firm_id query param.

Responses