Skip to main content
POST
cURL

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

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.