Skip to main content
GET
Cross-resource search (5-bucket)

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Query Parameters

query
string
required

Full-text search term. Alias: q.

Required string length: 1 - 500
q
string

Alias for query.

limit
integer
default:5

Results per bucket (1-25).

Required range: 1 <= x <= 25
expand
enum<string>[]

Pass expand[]=full to include raw DB row.

Available options:
full

Response

5-bucket search result envelope

object
enum<string>
Available options:
search_result
orders
object[]
products
object[]
accounts
object[]
invoices
object[]
serial_numbers
object[]
meta
object