Skip to navigation
API ReferenceCalls

List Calls

Retrieve a paginated list of calls across your whole company, including calls logged on projects, opportunities and accounts. Each call has projectId, opportunityId or accountId set to the record it’s logged on (all three are null for calls not yet linked to a record).

Supports:

  • Pagination (page_size, page)
  • Date filtering (updated_after, updated_before)
  • Filtering by outcome, reason and disposition
  • Sorting by creation time (order_by, newest first by default)

Authentication

x-api-keystring
API Key authentication via header

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptional

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

updated_beforestringOptional

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

order_byenumOptionalDefaults to desc
Sort by creation time. Defaults to newest first.
Allowed values:
outcomeenumOptional
Only return calls with this outcome
Allowed values:
reasonstringOptional<=255 characters

Only return calls with exactly this reason (see GET /calls/classification-options)

dispositionstringOptional<=255 characters

Only return calls with exactly this disposition (see GET /calls/classification-options)

Response

List of calls
idinteger
Call identifier
fromNumberstring
Phone number that initiated the call
toNumberstring
Phone number that received the call
isInboundboolean

Whether the call was inbound (true) or outbound (false)

createdAtstringformat: "date-time"
Creation timestamp
updatedAtstringformat: "date-time"
Last update timestamp
outcomeenum or nullOptional
Call outcome
Allowed values:
startTimestring or nullOptionalformat: "date-time"
When the call started
endTimestring or nullOptionalformat: "date-time"
When the call ended
reasonstring or nullOptional<=255 characters

Why the call happened. Company-defined: the value is the name of one of the company’s call reasons (see GET /calls/classification-options?type=REASON), so it can be any string up to 255 characters. Default reasons are Product, Process, Service, Accounting, Revenue opportunity, Feedback and Other. Calls logged before custom reasons existed hold the legacy uppercase value (e.g. SERVICE).

dispositionstring or nullOptional<=255 characters

How the call ended up. Company-defined: the value is the name of one of the company’s call dispositions (see GET /calls/classification-options?type=DISPOSITION), so it can be any string up to 255 characters. Default dispositions are Info provided, Visit scheduled, Issue resolved, Follow up, Escalation, No action, Unresponsive and Other. Calls logged before custom dispositions existed hold the legacy uppercase value (e.g. INFO_PROVIDED).

notestring or nullOptional

Human-editable note about the call. May contain HTML.

summarystring or nullOptional

AI-generated summary of the call. null when the call has no AI transcript.

transcriptTextstring or nullOptional

AI transcript of the call as plain text, one sentence per line in spoken order. null when the call has no AI transcript.

recordingUrlstring or nullOptional
URL to the call recording
transcriptUrlstring or nullOptional

URL to an externally hosted call transcript, if one was provided when the call was logged. For Coperniq phone calls use transcriptText.

missedCountinteger or nullOptional
Number of times the call was missed
classificationNotestring or nullOptional
For calls classified by Coperniq AI, the AI's explanation of why it chose the reason and disposition.
resolutionenum or nullOptional
For calls handled by a Coperniq AI agent, whether the caller's issue was resolved.
Allowed values:
projectIdinteger or nullOptional
The project this call is logged on, if it's on a project
opportunityIdinteger or nullOptional
The opportunity this call is logged on, if it's on an opportunity
accountIdinteger or nullOptional
The account this call is logged on, if it's on an account

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
502
Bad Gateway Error