Skip to main content
GET
/
customers
/
{id}
cURL
curl --request GET \
  --url https://campaigns.pingmee.co.il/customers/{id} \
  --header 'Cookie: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "profileImage": "<string>",
  "customerName": "<string>",
  "customerNickname": "<string>",
  "createdAt": 123,
  "lastActiveAt": 123,
  "email": "[email protected]",
  "platform": "whatsapp",
  "phoneNumberId": "<string>",
  "countryCode": "<string>",
  "associatedTo": "<string>",
  "parsedPhoneNumber": "<string>"
}

Authorizations

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

Path Parameters

​
id
string<string>
required

Phone number ID of the customer to get

Response

Customer

​
profileImage
string | null

Profile image URL if available

​
customerName
string

The name from WhatsApp or the originating platform

​
customerNickname
string

The name the business gave the customer

​
createdAt
number

Unix timestamp (milliseconds) when the customer was created

​
lastActiveAt
number

Unix timestamp (milliseconds) when the customer was last active

​
email
string<email>

Customer email address

​
platform
enum<string>

Messaging platform the customer is associated with

Available options:
whatsapp,
instagram,
facebookMessenger
​
phoneNumberId
string

Platform-specific phone number identifier

​
countryCode
string

Country calling code

​
associatedTo
string

Business or account the customer is associated with

​
parsedPhoneNumber
string

Normalized phone number if available