List WhatsApp conversations (Messages inbox)

GET /whatsapp/conversations

List WhatsApp conversations (Messages inbox)

cURL

curl --request GET \
  --url https://api.pineyard.ai/whatsapp/conversations \
  --header 'Authorization: Bearer <token>'

200

{
  "conversations": [
    {
      "id": "<string>",
      "phone": "<string>",
      "contactId": "<string>",
      "contactName": "<string>",
      "lastMessageAt": "<string>",
      "lastMessagePreview": "<string>",
      "lastMessageDirection": "INBOUND",
      "unreadCount": 123,
      "windowOpen": true,
      "waiting": true,
      "archived": true,
      "callId": "<string>",
      "campaignId": "<string>",
      "campaignName": "<string>",
      "campaignContactId": "<string>",
      "disposition": "<string>",
      "lastStatus": "QUEUED",
      "lastFailureReason": "<string>",
      "dispositionSource": "<string>",
      "replied": true,
      "everDelivered": true,
      "everRead": true,
      "everFailed": true,
      "docSent": true,
      "docDelivered": true,
      "docRead": true,
      "clicks": 123,
      "firstClickAt": "<string>"
    }
  ],
  "waitingCount": 123,
  "hasMore": true
}

Required scope: whatsapp.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

conversations · object[] · required

Show child attributes

waitingCount · number · required

hasMore · boolean · required