List catalog items

GET/api/v1/catalog-items

List Products & Services catalog items for the business.

Operation ID: list_catalog_items_api_v1_catalog_items_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.

active_onlybooleandefault: True: Only show active items.
item_typestring: Filter by type: service, non_inventory, inventory, bundle.
searchstring: Fuzzy match on name or SKU.
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

Schema: CatalogItemsListResponse

itemsarray · CatalogItemResponserequiredCatalogItemResponse

List of items

18 fields

totalinteger

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

limitinteger

Pagination limit

next_cursorstring

Cursor for next page

prev_cursorstring

Cursor for previous page

has_nextbooleanrequired

Whether there are more items

has_prevbooleanrequired

Whether there are previous items

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

GET/api/v1/catalog-items

bash

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