Skip to main content
GET
Returns a paginated tabular report of inbound calls for an inbound configuration. Set export_csv=true to download CSV (text/csv) instead of JSON.

Authentication

X-API-Key
string
required
Project API key for this organization and project. Format: bot_live_…

Path parameters

organization_id
string
required
Organization ID. Must match the API key.
project_id
string
required
Project ID. Must match the API key.
inbound_id
string
required
Inbound configuration ID.

Query parameters

skip
integer
default:"0"
Number of rows to skip.
limit
integer
default:"20"
Page size. Range: 1100.
export_csv
boolean
default:"false"
When true, returns a CSV file download instead of JSON.
filters
string
JSON filter object, for example {"status":"completed"}.
sort
string
JSON sort object, for example {"created_at":-1}.

Response

JSON mode:
columns
array
required
Column definitions (key, header, and related metadata).
rows
array
required
Report rows keyed by column key.
pagination
object
required
Pagination metadata for the rows.
CSV mode returns raw CSV with Content-Disposition: attachment; filename=report_calls_YYYYMMDD_HHMMSS.csv.

Errors

401
Unauthorized
Missing, invalid, or revoked API key.
403
Forbidden
API key is not authorized for this organization or project.