v1

latestOpenAPI 3.0.32026-07-248257161.1 KB

Customers

search customers

This API searches customer by email or phone or name and returns list of matched customers.

get/customers/search

Query parameters

emailstring

search customer by email

phonestring

search customer by phone

namestring

search customers by name. The search string should be the name of beginning of the name. Many customers may be found

Response

returns list of customers.

idstring uuid

unique uuid of the customer

namestring

customer's full name

phonestring

customer's mobile phone number.

emailstring

the email of the customer

addressstring

Full street address, which MAY include house number, street name, Post Office Box, etc

citystring

City or locality component.

postalCodestring

Zip code or postal code component.

countrystring required

ISO3166-1 alpha-2 two letter, uppercase.

localestring

User locale, language is lower case. Country in upper case

createdAtstring

The date time that record was created in our system.

updatedAtstring

The date time that record was updated in our system.

Example response

[
  {
    "id": "fbd2053b-638d-4133-957e-3caf63e6b79c",
    "name": "John Dao",
    "email": "john.dao@example.com",
    "address": "23, avenue de la liberté",
    "city": "Dakar",
    "country": "SN",
    "locale": "fr-FR",
    "createdAt": "2022-06-20T17:17:11Z",
    "updatedAt": "2022-06-20T17:17:11Z"
  }
]