ShopEazydevelopers
API referenceMerchant API BetaWhats App

One conversation and its messages

Beta
Credentials
  • OAuth access token
Scopes
messages:read
GET
/v1/merchant/stores/{storeId}/whatsapp/threads/{threadId}

Access: OAuth scope messages:read (a grant with messages:send passes too); not write-gated.

Authorization

merchantOAuth messages:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: messages:read

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

threadId*string

The customer's WhatsApp id (phone digits).

Query Parameters

limit?integer

Default 100, max 200.

Range1 <= value <= 200
Default100

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/whatsapp/threads/<threadId>' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "thread": {      "id": "string",      "name": "string",      "phone": "string",      "preview": "string",      "lastMessageAt": 0,      "lastDirection": "in",      "unread": 0,      "needsAttention": true,      "canReply": true,      "replyWindowEndsAt": 0    },    "messages": [      {        "id": "string",        "direction": "in",        "type": "string",        "body": "string",        "at": 0,        "status": "string",        "automated": true,        "actorName": "string",        "error": "string"      }    ]  }}