Customers

Get customers list

post

Retrieve list of customers with optional filters

Header parameters

X-API-KEYstringrequired

Your API key

X-SECRET-KEYstringrequired

Your Secret key

Body

app_idstringrequired

_idstringoptional

user_idstringoptional

emailstringoptional

phonestringoptional

event_since_datestring · dateoptional

updated_sincestring · dateoptional

limitinteger · max: 1000optional

offsetintegeroptional

fulldatabooleanoptional

If true, the response will include all data for the customer including visits, purchases, memberships, and sales notes

eventsbooleanoptional

If true, the response will include all events for the customer

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gleantap.com/v2/ExternalApi/getCustomers' \
  --header 'X-API-KEY: text' \
  --header 'X-SECRET-KEY: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "app_id": "text",
    "_id": "text",
    "user_id": "text",
    "email": "text",
    "phone": "text",
    "event_since_date": "2025-04-02",
    "updated_since": "2025-04-02",
    "limit": 1,
    "offset": 1,
    "fulldata": true,
    "events": true
  }'

200

400

200

{
  "members": [
    {
      "id": "text",
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "phone": "text",
      "last_location": "text",
      "email_optout": 1,
      "sms_optout": 1,
      "created_date": "2025-04-02T15:34:47.073Z"
    }
  ]
}

Customers list retrieved successfully