Brand Data API
Conversations
GET
/conversationsList this brand's conversations, newest 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/conversations"{ "data": [ { "id": "string", "createdAt": "string", "updatedAt": "string", "lastEngagedAt": "string", "lastReceivedAt": "string", "awaitingReply": true, "cartValue": "129.99", "cartCurrency": "USD", "customer": { "name": "Jane Doe", "handle": "+15551234567" }, "workflow": { "name": "string", "type": "string" }, "checkoutState": "abandoned", "lastMessage": { "body": "string", "direction": "string", "createdAt": "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
/conversations/{id}Fetch a single conversation 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/conversations/string"{ "data": { "id": "string", "createdAt": "string", "updatedAt": "string", "lastEngagedAt": "string", "lastReceivedAt": "string", "awaitingReply": true, "cartValue": "129.99", "cartCurrency": "USD", "customer": { "name": "Jane Doe", "handle": "+15551234567" }, "workflow": { "name": "string", "type": "string" }, "checkoutState": "abandoned", "lastMessage": { "body": "string", "direction": "string", "createdAt": "string" } }}{ "error": "string"}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}{ "error": { "code": "conversation_not_found", "message": "string" }}