List users

GET/api/v1/users

List users with optional filtering. Pass x-business-id header or business_id for business-scoped view; firm_id for firm-wide view.

Operation ID: list_users_api_v1_users_get·View as markdown·OpenAPI slice

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
business_idstring
firm_idstring
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

Responses

200Successful Response

successboolean
messagestring
codestring
dataUserCursorListResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject