List customers
GET/apps-api/v1/customers
Responses are private and never cached.
Required permission
customers.read
Query parameters
limitintegerOptional
1 to 100; default 25
cursorstringOptional
max 1024 characters
emailstring (email)Optional
updatedAfterstring (date-time)Optional
Headers
Poltura-InstallationstringRequired
Response
customersobject[]Required
max 100 items
idstringRequired
emailstring (email)Required
firstNamestring | nullRequired
lastNamestring | nullRequired
phonestring | nullRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
tagsstring[]Required
max 32 items
metadataobjectRequired
nextCursorstring | nullRequired
max 1024 characters
Errors
| Status | Code |
|---|---|
| 400 | invalid_input, unsupported_api_version |
| 401 | unauthorized |
| 403 | forbidden, insufficient_scope |
| 404 | not_found |
| 409 | conflict, quota_exceeded |
| 412 | stale_version |
| 413 | payload_too_large |
| 429 | rate_limited |
| 503 | unavailable |