Skip to content

Search active customers

Request

Full-text search across customer name, phone, and email. Returns up to 10 active matches.

Security
oauth2ClientCredentials(Required scopes: customers:read)
Query
qstringrequired

Search query string

Example:q=Acme
Headers
business_idstringrequired

Business identifier for the request

curl -i -X GET \
  'https://developer.boyahq.com/_mock/v2/openapi/customers/search?q=Acme' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'business_id: string'

Responses

Search results returned successfully