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
}
'import requests
url = "https://campaigns.pingmee.co.il/customers"
payload = {
"lastEvaluatedKey": {},
"limit": 25
}
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({lastEvaluatedKey: {}, limit: 25})
};
fetch('https://campaigns.pingmee.co.il/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://campaigns.pingmee.co.il/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lastEvaluatedKey' => [
],
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://campaigns.pingmee.co.il/customers"
payload := strings.NewReader("{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<api-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://campaigns.pingmee.co.il/customers")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.pingmee.co.il/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"customers": [
{
"profileImage": "<string>",
"customerName": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"createdAt": 123,
"lastActiveAt": 123,
"email": "jsmith@example.com",
"phoneNumberId": "<string>",
"countryCode": "<string>",
"associatedTo": "<string>",
"parsedPhoneNumber": "<string>"
}
],
"hasMoreItemsToFetch": true,
"lastEvaluatedKey": {}
}{
"error": "<string>",
"message": "<string>"
}Customers
Get Customers
Returns all customers using pagination
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
}
'import requests
url = "https://campaigns.pingmee.co.il/customers"
payload = {
"lastEvaluatedKey": {},
"limit": 25
}
headers = {
"Cookie": "<api-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Cookie: '<api-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({lastEvaluatedKey: {}, limit: 25})
};
fetch('https://campaigns.pingmee.co.il/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://campaigns.pingmee.co.il/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'lastEvaluatedKey' => [
],
'limit' => 25
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Cookie: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://campaigns.pingmee.co.il/customers"
payload := strings.NewReader("{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Cookie", "<api-key>")
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://campaigns.pingmee.co.il/customers")
.header("Cookie", "<api-key>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://campaigns.pingmee.co.il/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Cookie"] = '<api-key>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"lastEvaluatedKey\": {},\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"customers": [
{
"profileImage": "<string>",
"customerName": "<string>",
"customerNickname": "<string>",
"description": "<string>",
"createdAt": 123,
"lastActiveAt": 123,
"email": "jsmith@example.com",
"phoneNumberId": "<string>",
"countryCode": "<string>",
"associatedTo": "<string>",
"parsedPhoneNumber": "<string>"
}
],
"hasMoreItemsToFetch": true,
"lastEvaluatedKey": {}
}{
"error": "<string>",
"message": "<string>"
}Authorizations
Personal access token from Pingmee Settings → Developer Tools
Business API key from Pingmee Settings → Developer Tools
Body
application/json
Optionally provide pagination parameters to retrieve the next page of customers.
Response
Customers
List of customers returned for this page of results.
Show child attributes
Show child attributes
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.
⌘I