Skip to main content
GET
/
customer
/
search
/
{query}
Search customers
curl --request GET \
  --url https://start.aiotic.ai/customer/search/{query} \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "number": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "postal_code": "<string>",
      "city": "<string>",
      "address": "<string>",
      "contact_person": "<string>",
      "phone_number": "<string>",
      "vat_number": "<string>",
      "email": "<string>",
      "coc_number": "<string>",
      "home_page": "<string>",
      "similarity": 123
    }
  ],
  "total": 123,
  "limit": 123
}

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