Brand Data API
Contacts
GET
/contactsList this brand's contacts (customers), oldest first, cursor-paginated.
Authorization
bearerAuth AuthorizationBearer <token>
Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.
In: header
Query Parameters
limit?string
Max items to return (1–100, default 50). Out-of-range numbers are clamped; a non-numeric value falls back to 50.
cursor?string
Opaque pagination cursor from a previous response's nextCursor.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/contacts"{ "data": [ { "id": "string", "givenName": "string", "familyName": "string", "name": "string", "source": "string", "acceptsSmsMarketing": true, "createdAt": "string", "updatedAt": "string" } ], "nextCursor": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}GET
/contacts/{id}Fetch a single contact owned by this brand; 404 on a miss.
Authorization
bearerAuth AuthorizationBearer <token>
Brand Data API key issued for your Custom E-Com integration, sent as Authorization: Bearer <key>.
In: header
Path Parameters
id*string
Resource id.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/contacts/string"{ "data": { "id": "string", "givenName": "string", "familyName": "string", "name": "string", "source": "string", "acceptsSmsMarketing": true, "createdAt": "string", "updatedAt": "string" }}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}