Skip to content
OnCoreDocs
Calls

GEThttps://core-api.heysadie.ai/calls

limit offset assistantId status dateFrom dateTo durationMin durationMax sortBy search success data calls id cid recordingUrl type startedAt endedAt transcript summary orgId cost costBreakdown customerNumber endedReason callSource callSid supervisorAnswered analysis messages callDuration assistantName createdAt updatedAt total metadata timestamp version path error code message details field

List calls

Try it in the API Explorer

Example request

Terminal
curl "https://core-api.heysadie.ai/calls?limit=10&offset=0" \
  -H "Authorization: ApiKey YOUR_API_KEY"

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme. See Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Query parameters

limitstringoptional

Maximum number of items to return

offsetstringoptional

Number of items to skip from the beginning

assistantIdstringoptional

Filter by assistant ID (UUID)

statusstringoptional

Filter by call status

dateFromstringoptional

Filter calls started at or after this ISO datetime

dateTostringoptional

Filter calls started at or before this ISO datetime

durationMinstringoptional

Filter calls with duration >= this value (seconds)

durationMaxstringoptional

Filter calls with duration <= this value (seconds)

sortBystringoptional

Sort by field: startedAt (default) or createdAt

searchstringoptional

Free-text search across customer number and assistant name

Responses

200
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 2 child properties
callsobject[]required

List of calls

Show 24 item properties
idstringrequired
cidstring | nulloptional

Provider call identifier (LiveKit). Correlates this call with performance metrics and session insights.

recordingUrlstring | nulloptional
typestring | nullrequired
startedAtstring (date-time) | string (date) | number | nullrequired
endedAtstring (date-time) | string (date) | number | nullrequired
transcriptstring | nullrequired
summarystring | nullrequired
orgIdstring | nullrequired
costnumber | nullrequired
costBreakdownany | nullrequired
customerNumberstring | nullrequired
statusstring | nullrequired
endedReasonstring | nullrequired
callSourcestring | nulloptional

Channel the call entered on: pstn | webrtc | whatsapp | failover-direct (forwarded straight to a human line without reaching the assistant).

callSidstring | nulloptional

Twilio CallSid of the inbound PSTN leg, when known.

supervisorAnsweredboolean | nulloptional
analysisany | nullrequired
messagesany | nullrequired
callDurationnumber | nullrequired
assistantIdstring | nullrequired
assistantNamestring | nullrequired
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
totalnumberrequired

Total number of calls found

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400The request is invalid. `details` lists each field that failed
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401Missing or invalid credentials
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403The credentials are valid but may not use this route
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

The credentials may not use this route

Allowed values:"FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404Not found, or outside the caller's scope
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An id names nothing the caller can see

Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested