Skip to main content
GET
List email and SMS messages

Authorizations

Authorization
string
header
required

Workspace API key (wk_) with the Workspace read API scope enabled.

Path Parameters

agentId
string
required

The agent id.

Query Parameters

pageSize
integer

Page size (default 50).

Required range: 1 <= x <= 200
page
integer

Page number (default 1).

Required range: x >= 1
direction
enum<string>
Available options:
inbound,
outbound
channel
enum<string>
Available options:
email,
sms
since
string

ISO date string — only messages after this.

until
string

ISO date string — only messages before this.

Response

Success. Empty result sets are also 200.

Response fields for this endpoint are not modelled in the spec yet. See the Workspace API guide for the shapes.