Skip to main content
GET
CLI
Reading does not mark the thread as read: use Update Thread with markRead: true.

Reading older messages

The response holds the latest limit messages (30 by default). When olderMessages is true, call again with beforeMessageId set to the first messageId you received.

Message fields

  • text is always plain text, also for emails; pass includeHtml=true to get the email HTML as html too.
  • status, failureReason, seenAt and templateName are on outbound messages only.
  • media holds a WhatsApp image, audio, video or document; attachments the files of an email.

Permissions

The API key needs the Inbox permission. A thread of another workspace answers 404, like a missing one.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

threadId
integer
required

The threadId from List Threads or Search Threads.

Query Parameters

limit
integer
default:30

Messages to return.

Required range: 1 <= x <= 100
beforeMessageId
integer

Page back: only messages older than this one.

includeHtml
boolean
default:false

Also return the email HTML as html.

Response

The thread and its messages

data
object