Skip to main content
POST
/
customers
cURL
curl --request POST \
  --url https://campaigns.pingmee.co.il/customers \
  --header 'Content-Type: application/json' \
  --header 'Cookie: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "lastEvaluatedKey": {},
  "limit": 25
}
'
{
  "customers": [
    {
      "profileImage": "<string>",
      "customerName": "<string>",
      "customerNickname": "<string>",
      "createdAt": 123,
      "lastActiveAt": 123,
      "email": "[email protected]",
      "platform": "whatsapp",
      "phoneNumberId": "<string>",
      "countryCode": "<string>",
      "associatedTo": "<string>",
      "parsedPhoneNumber": "<string>"
    }
  ],
  "hasMoreItemsToFetch": true,
  "lastEvaluatedKey": {}
}

Authorizations

​
Cookie
string
header
required
​
x-api-key
string
header
required

Body

application/json

Optionally provide pagination parameters to retrieve the next page of customers.

​
lastEvaluatedKey
object

Key returned from the previous request. Pass this value to fetch the next page of results.

​
limit
number
default:25

Maximum number of customers to return.

Required range: 1 <= x <= 100

Response

Customers

​
customers
object[]

List of customers returned for this page of results.

​
hasMoreItemsToFetch
boolean
​
lastEvaluatedKey
object

If present, call the same endpoint again and pass this value as lastEvaluatedKey to retrieve the next page of results. Pagination is cursor-based, not page-number based.