Skip to main content
GET
Page stored inbound mail for a workspace address

Authorizations

X-Api-Key
string
header
required

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

Query Parameters

workspaceId
string<uuid>

Workspace the request is scoped to. Optional for API keys: a key is bound to one workspace when it is created, and naming any other workspace returns an opaque 404.

addressId
string<uuid>
required

Agent Mail address UUID, resolved inside the caller's workspace. Absent, repeated, foreign, and malformed ids all return an opaque 404.

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_-]+$

Response

Bounded page of stored mail (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.