Global search

GET/api/v1/search

Search across products, variants, customers, invoices, vendors, and more.

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

entity_typestring

Limit to: products, variants, customers, invoices, vendors, transactions, journal_entries, ledgers, emails

date_fromstring

Results after this date (ISO 8601: YYYY-MM-DD)

date_tostring

Results before this date (ISO 8601: YYYY-MM-DD)

search_termstringrequired
limitinteger

Pagination limit

cursorstring

Cursor for pagination

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

Responses

200Successful Response

successboolean
messagestring
codestring
dataSearchResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject