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

search string: Search users by name or email
id string: Filter by user UUID
email string: Filter by exact email address
business_id string: Filter by business UUID. Returns users in that business only.
firm_id string: Filter by advisory firm UUID. Firm-wide: all users in that firm.
cursor string: Cursor for pagination
limit integer: Pagination limit
direction string default: next: Pagination direction: 'next' or 'prev'
include_total_count boolean default: False: Whether to include total count (expensive - avoid if possible)
sort_by string: Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descending boolean default: True: Sort direction: true for descending (newest/largest first), false for ascending

Headers

x-firm-id string: Advisory firm UUID for firm-wide view. Same as firm_id query param.

Responses

200 Successful Response

Schema: UserCursorListResponse

items array · UserResponse requiredUserResponse

List of items

11 fields

email string · email required: User email address (unique identifier).
first_name string: User's first name.
last_name string: User's last name.
photo_url string: URL to user's profile photo.
onboarded boolean: Whether user has completed onboarding.
props object: Additional user properties/settings.
id string required: User UUID.
created_at string · date-time required: Account creation timestamp.
updated_at string · date-time required: Last profile update timestamp.
firm_ids array · string: Advisory firm UUIDs the user belongs to.
role Role: User's role in a business (only included when filtering by business_id).

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

GET /api/v1/users

bash

curl -X GET 'https://api.ondayzero.com/api/v1/users' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/users', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
  },
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

response = httpx.get("https://api.ondayzero.com/api/v1/users", headers=headers)
data = response.json()