List business users

GET /api/v1/businesses/users

Get users associated with a business, optionally including advisory firm users.

Operation ID: list_business_users_api_v1_businesses_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

include_advisory_users boolean default: False: Include users from the parent advisory firm if one exists.
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

Responses

200 Successful Response

Schema: AssociatedUserCursorListResponse

items array · AssociatedUserResponse requiredAssociatedUserResponse

List of items

12 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 requiredRole: Role: owner, admin, member, or viewer
source UserSource requiredUserSource: Source of association: business_user (direct) or advisor_user (via advisory firm).

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

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/businesses/users

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/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/businesses/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/businesses/users", headers=headers)
data = response.json()