API referenceCustomers
List customers in the API key environment
GET
api-keyheader
x-api-key<token>Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).
status?stringDefault
"ALL"Value in
"ALL""ACTIVE""DISABLED"search?stringSearches name, customer ID, email, and phone number.
Length
length <= 120page?numberRange
1 <= valueDefault
1pageSize?numberRange
1 <= value <= 100Default
20x-api-secret?stringRecommended: API secret sent over HTTPS. You may send it as Authorization: Bearer instead. If supplied, x-timestamp and x-signature are not required.
x-timestamp?stringLegacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.
x-signature?stringLegacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).
x-idempotency-key*string1–128 letters/digits or ._:-. Same key and payload replay for 24 hours; conflicting, in-flight, or expired keys return 409. Never change a key to retry an uncertain payment.
application/json- response
environment*stringValue in
"SANDBOX""LIVE"summary*items*array<>total*numberpage*numberpageSize*numbercurl -X GET 'https://api.creddot.com/api/v1/customers' \ -H 'x-idempotency-key: string'Example Response
{ "environment": "SANDBOX", "summary": { "total": 20, "active": 18, "disabled": 2 }, "items": [ { "id": "string", "customerId": "string", "name": "string", "email": "user@example.com", "phoneNumber": {}, "status": "ACTIVE", "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}