Skip to main content
GET
List conversations
Returns records, total, page, page_size, and can_review. Pages start at 1; page size defaults to 25 and has a maximum of 100. An empty records array is a valid result. Filter by agent, channel, state, outcome, date range, or review view. search is a text query. Date filters accept ISO 8601; a timezone offset or Z avoids ambiguity. The start must not be later than the end. Use can_review to decide whether to show review actions. Each record’s id is the numeric run ID used by the detail and review operations.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Query Parameters

Maximum string length: 200
start_date
string<date-time> | null
end_date
string<date-time> | null
agent_id
integer | null
channel
enum<string> | null
Available options:
phone,
web,
chat
state
enum<string> | null
Available options:
initialized,
running,
completed
outcome
string | null
Maximum string length: 150
view
enum<string>
default:all
Available options:
all,
needs_review,
flagged,
missing_artifacts
sort
enum<string>
default:created_at
Available options:
created_at,
duration,
agent
order
enum<string>
default:desc
Available options:
asc,
desc
page
integer
default:1
Required range: x >= 1
page_size
integer
default:25
Required range: 1 <= x <= 100

Response

Successful Response

page
integer
required
page_size
integer
required
records
ConversationRecord · object[]
required
total
integer
required
can_review
boolean
default:false