API Reference

Search customers

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/actions/search-customers

Search all customers matching for parameters.

Searches across customer accounts by name, date of birth, card number, email, phone, or external ID simultaneously. Unlike GET /customers, this endpoint combines all identifying fields in a single search and is optimised for point-of-sale customer lookup and identification workflows.

⚠️ Action method for search customers is available only in Enterprise interface.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search by first name.

string

Search by last name.

string

Customer's date of birth. Accepts the format YYYY-MM-DD or DD.MM.YYYY.

string

Number of the customer card.

string
enum

Mode of search results.

Possible values are: strict - return only 100% matching results / none - return results without strict matching (default behavior, all query parameters are optional)

⚠️ Caution: Strict mode makes all query parameters required. For a successful result you have to set all parameters.

⚠️ Caution: Currently the whole resource is returning results only in strict mode.

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago