Skip to main content
GET
Fetch call history

Authorizations

Authorization
string
header
required

Generate tokens from your profile settings at app.uponai.com.

Headers

X-Actor-Type
enum<string>

Optional actor type for privileged white-label context selection.

Available options:
platform_admin,
provider_admin,
tenant_admin,
end_user
X-Provider-Id
integer

Optional provider scope identifier for privileged multi-tenant access.

X-Tenant-Id
integer

Optional tenant/workspace context override.

X-Impersonation-Reason
string

Required for privileged tenant-scoped requests when actor type is platform or provider admin.

Query Parameters

workspaceId
integer
required

Workspace identifier. Call GET /api/workspaces to list workspaces accessible to your token.

agentId
string

Filter call listings to a specific agent.

agentVersion
integer

Filter call history to a specific persisted agent version captured at call time.

status
string

Filter calls by status.

Search by call SID, phone number, platform call ID, customer name, or agent name.

fromDate
string<date-time>

Inclusive start date for call listing filter.

toDate
string<date-time>

Inclusive end date for call listing filter.

page
integer
default:1
Required range: x >= 1
limit
integer
default:20

Page size for list endpoints.

Required range: 1 <= x <= 100
includeArchived
boolean

When true, include archived calls in the response.

includeChildCalls
boolean

When true, include child calls linked to transfer or split-call workflows.

Response

200 - application/json

Paginated call history.

success
boolean
calls
object[]
pagination
object
filters
object