VYG Developer Docs

Messages

GET/conversations/{id}/messages

List one conversation's messages, oldest first, cursor-paginated. The parent conversation's brand ownership is verified first; a non-owned id 404s with zero messages.

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.

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

application/json

curl -X GET "https://example.com/conversations/string/messages"
{  "data": [    {      "id": "string",      "direction": "string",      "body": "string",      "status": "string",      "createdAt": "string",      "updatedAt": "string",      "sentAt": "string",      "scheduledFor": "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"  }}
{  "error": {    "code": "conversation_not_found",    "message": "string"  }}