Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
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.

get/customers/actions/search-customers

Query parameters

first_namestring

Search by first name.

last_namestring

Search by last name.

birthdatestring

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

card_numberstring

Number of the customer card.

mode'strict' | 'none'

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.

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "strict": [
      {
        "customer_id": "84b9167cc2f01ff007d98e1633",
        "match": 100
      }
    ]
  }
}