v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search Customers

Fetches customers from all sources using query string.

For example, you can fetch customers whose identifiers starting with 99455, or name that starts with ‘john’ and so on.

get/customers/search

Query parameters

qstring required

Enter the keyword based on which you want to fetch customers. It will fetch customers whose first name, last name, or registered identifiers start with keyword that you pass.

limitinteger

offsetinteger

Headers

X-CAP-API-OAUTH-TOKENstring

Generated access token for oAuth authentication. If the token expires, you need to regenerate the access token.

Response

200

Example response

{
  "pagination": {
    "limit": 10,
    "total": 33
  },
  "data": [
    {
      "userId": 261504789,
      "matchedIdentifiers": [
        {
          "idType": "firstName",
          "idValue": "Tom",
          "source": "INSTORE"
        }
      ],
      "profiles": [
        {
          "source": "INSTORE",
          "firstName": "Tom",
          "lastName": "Sawyer"
        }
      ]
    }
  ]
}