Skip to main content
GET
Search customers

Authorizations

X-API-Key
string
header
required

API key for authentication. Required on all endpoints except /healthcheck. Customer and product endpoints also accept a customer-specific API key.

Path Parameters

query
string
required

Search query text

Query Parameters

top_k
integer
default:10

Number of top results to return

Required range: 1 <= x <= 1000

Response

Customers matching the search query

items
object[]
required

List of customer objects with similarity scores

total
integer
required

Total number of customers in the system

limit
integer
required

Maximum number of customers returned