Skip to main content
GET
List voice sessions

Authorizations

Authorization
string
header
required

Bearer authentication: send your API key, agent key, or OAuth access token as Authorization: Bearer <credential>.

Headers

X-Instance-ID
string | null

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Maximum string length: 1024

Query Parameters

limit
integer
default:50

Maximum results per page.

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

Cursor from the previous page.

Maximum string length: 1024
status
enum<string>

Filter by display status.

Available options:
completed,
failed,
payment_link_sent,
declined,
cancelled,
in_progress,
expired
createdAfter
string

Only sessions created at or after this ISO 8601 timestamp.

Maximum string length: 64
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
createdBefore
string

Only sessions created at or before this ISO 8601 timestamp.

Maximum string length: 64
Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2})$
merchantPartyId
string

Restrict results to sessions collecting for this merchant party.

Pattern: ^pty_[0-9a-f]{32}$

Response

Successful Response

data
VoiceSessionListItemResource · object[]
required
meta
object
required