Skip to main content
GET
Get a call

Authorizations

Authorization
string
header
required

A CallVA API token, sent as Authorization: Bearer <token>.

Creating one. In the CallVA dashboard, open the organization's Settings, then API Keys, and choose Create API Key: give the key a name, choose its role, and choose its project scope - All projects for an organization-wide token, or one project for a project token. The key is shown once, when it is created, and cannot be read again; store it then. Creating keys needs the api_tokens.create permission, which owners and admins hold, and a key cannot create another key.

Organization-wide or project token. A project token works in the one project it was created for; any project named in the request is ignored. An organization-wide token reaches the projects of its organization, and each request names its project with the X-Project-ID header or project_id (query string for reads and deletes, body for writes).

What it can call. The token's role decides which endpoints it may call; each endpoint names the permission it requires, and a token whose role lacks it is answered 403.

Headers

X-Project-ID
string<uuid>

The project this request acts in. Required with an organization-wide token (or send project_id instead); ignored with a project token, which always acts in its own project.

Path Parameters

call
string<uuid>
required

The call ID

Response

success
boolean
required
message
string
required
Allowed value: "Call retrieved successfully"
data
CallResource · object
required

A call record. Besides its identity, it carries every field of the project's data model at the top level, keyed by field key, with the value typed as the field is (GET /custom-fields lists them); dates and times are ISO 8601 in UTC.