Skip to main content
GET
Get Call Transcript

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The call's id as Place Call or List Calls gave it: out_… or sch_… for a call you placed, the call reference for any other.

Example:

"out_9f2c1a44-6b0e-4c1d-8a7f-2e5b3c9d1f60"

Query Parameters

format
enum<string>
default:json

json (the default) for the turns as JSON, txt for a plain-text attachment.

Available options:
json,
txt
Example:

"json"

Response

The transcript, as JSON or, with format=txt, as a text/plain attachment.

id
string
required

The call's id.

callRef
string | null
required

The attempt that rang.

status
enum<string>
required

Where the call is.

Available options:
scheduled,
ringing,
connected,
completed,
missed,
failed,
cancelled
agent
object | null
required

The agent on the call. Null on a call forwarded to a phone when no agent answered the number (forwardedTo is set).

startedAt
string<date-time> | null
required
endedAt
string<date-time> | null
required
turns
object[]
required