Global search across billing entities.
Global search
Free-text search across customers and their related records. A customer's name is denormalised onto their invoices and credit notes, so querying a customer name surfaces that customer (ranked first) together with their related records. Results are scoped to the caller's organization and workspace and filtered to the entity types the caller is permitted to read.
query Parameters
qFree-text query (matches display_name, searchable, secondary_text)
Free-text query (matches display_name, searchable, secondary_text)
typesComma-separated entity types to include (customer,product,invoice). Defaults to all.
Comma-separated entity types to include (customer,product,invoice). Defaults to all.
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
tagFilter by tag id or name (repeatable)
Filter by tag id or name (repeatable)
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Global search › Responses
OK
Customer search overview
Returns a single customer's profile plus a recency-ordered preview of their related records (invoices, credit notes, ...), grouped by entity type. Groups are limited to the entity types the caller may read; results are scoped to the caller's organization and workspace.
query Parameters
customer_idCustomer UUID to build the overview for
Customer UUID to build the overview for
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Customer search overview › Responses
OK