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

customerPartyId
string

Customer party to act for (pty_*). Omit for your account's call log, including delegated activity. Requires authorization from that customer.

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

Only sessions associated with this payment intent.

Pattern: ^pmi_[0-9a-f]{32}$
status
enum<string>

Filter by call-session status.

Available options:
awaitingCall,
inProgress,
ended,
failed,
canceled,
expired
createdAfter
string

Only sessions created after this RFC 3339 timestamp (exclusive).

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 before this RFC 3339 timestamp (exclusive).

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

Maximum results per page.

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

Cursor from the previous page with the same customer and filters.

Maximum string length: 1024

Response

Successful Response

data
VoiceSessionResource · object[]
required
meta
object
required