200Successful Response
Schema: SuccessEnvelope_SearchResponse_
successbooleanmessagestringcodestringdataSearchResponse
/api/v1/searchSearch across products, variants, customers, invoices, vendors, and more.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
entity_typestringLimit to: products, variants, customers, invoices, vendors, transactions, journal_entries, ledgers, emails
date_fromstringResults after this date (ISO 8601: YYYY-MM-DD)
date_tostringResults before this date (ISO 8601: YYYY-MM-DD)
search_termstringrequiredlimitintegerPagination limit
cursorstringCursor for pagination
directionstringdefault: nextPagination direction: 'next' or 'prev'
include_total_countbooleandefault: FalseWhether to include total count (expensive - avoid if possible)
sort_bystringColumn name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descendingbooleandefault: TrueSort direction: true for descending (newest/largest first), false for ascending
Schema: SuccessEnvelope_SearchResponse_
successbooleanmessagestringcodestringdataSearchResponseSchema: HTTPValidationError
detailarray · ValidationErrorValidationErrorlocarray · string | integerrequiredmsgstringrequiredtypestringrequiredinputobjectctxobject