Skip to main content
GET
Page stored SMS messages for a workspace number

Authorizations

X-Api-Key
string
header
required

Workspace API key, created in the dashboard under Settings → API Keys.

Path Parameters

workspaceId
string<uuid>
required

Workspace UUID. Caller must have access.

phoneNumberId
string<uuid>
required

Phone-number inventory UUID. Foreign and missing ids return an opaque 404.

Query Parameters

limit
integer
default:50

Decimal integer without signs, whitespace, or leading zeroes.

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

Opaque validated pagination cursor from the previous page.

Required string length: 1 - 512
Pattern: ^[A-Za-z0-9_-]+$
sender
string

Exact case-sensitive stored sender string; no trimming or brand inference. Omit to include null senders.

Required string length: 1 - 4096

Response

Bounded page of stored messages (may be empty)

data
object[]
required
Maximum array length: 100
nextCursor
string | null
required

Pass unchanged as cursor; null when no older retained rows were observed.