List all managerial buckets (default + custom)

GET /api/v1/businesses/{business_id}/cfo-portal/buckets

Return all managerial buckets available for this business.

The response includes both the built-in default buckets and any custom buckets defined by this business. Default buckets have is_default: true rows are built-in buckets with fixed keys; use PUT .../buckets/{bucket_key} to customize label and color.

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

Path

business_id string required

Responses

200 Successful Response

Schema: CustomBucketsListResponse

buckets array · CustomBucketResponse requiredCustomBucketResponse
9 fields
id string required
key string required
label string required
color string required
classification string required
sort_order integer required
is_active boolean required
is_default boolean

True for built-in default buckets

can_delete boolean

Whether the bucket can be deleted from Recipe Book. Some built-in buckets are locked.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

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