Skip to main content
GET
List messages

Authorizations

Authorization
string
header
required

Use an API key as a bearer token: Authorization: Bearer sk_live_...

Each key has a set of scopes that gate which endpoints it can call: messages:read, messages:write, chats:read, lines:read, reactions:read, reactions:write, typing:read, typing:write, receipts:read, receipts:write, webhooks:read, webhooks:write, outbox:read, files:read, files:write. Keys can also be restricted to a subset of lines.

Query Parameters

from
string
required

Line handle (phone number or Apple ID)

Example:

"+15551234567"

to
string
required

Chat identifier (phone number, Apple ID, or chat ID)

Example:

"+15559876543"

limit
integer
default:50

Maximum number of items to return (1-100, default: 50)

Required range: 1 <= x <= 100
cursor
string

Opaque cursor for pagination. Use the next_cursor value from a previous response.

Response

List of messages

data
object[]
has_more
boolean

Whether more items exist beyond this page

next_cursor
string | null

Cursor to pass as cursor query parameter for the next page

request_id
string