Customers
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
200
Customers list retrieved successfully
application/json
400
Invalid request
post
POST /v2/ExternalApi/getCustomers HTTP/1.1
Host: api.gleantap.com
X-API-KEY: text
X-SECRET-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"app_id": "text",
"_id": "text",
"user_id": "text",
"email": "text",
"phone": "text",
"event_since_date": "2025-07-05",
"updated_since": "2025-07-05",
"limit": 1,
"offset": 1,
"fulldata": true,
"events": true
}
{
"members": [
{
"id": "text",
"firstname": "text",
"lastname": "text",
"email": "text",
"phone": "text",
"last_location": "text",
"email_optout": 1,
"sms_optout": 1,
"created_date": "2025-07-05T22:40:10.844Z"
}
]
}
Last updated