Global Search

GET 
/api/search

Performs a global search across multiple entity types.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Query Parameters:

• q (required): Search term
• types[] (optional): Limit search to specific entity types

Permissions: each entity type is searched only when the user holds its read permission (products.index, sales_orders.index, purchase_orders.index). Types the user cannot read return no results rather than an error.

Request

Responses

200

OK

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.