Sign in
Calls

Get a call

Returns a single call by ID. Accepts both integer ID and UUID. Use the expand query param to include related entities inline.

get/calls/{id}

Path parameters

idstring required

Call ID (positive integer) or UUID

Example:1

Call ID (positive integer) or UUID

Query parameters

expandstring

Comma-separated list of relations to expand. Allowed values: contacts, deal, account, users

Example:contacts,deal

Comma-separated list of relations to expand. Allowed values: contacts, deal, account, users

Response

Call details

idnumber required

Call ID

namestring required

Call title

datestring nullable required

Call date in ISO 8601 format

durationnumber nullable required

Call duration in seconds

directionstring nullable required

Call direction: inbound or outbound

languagestring nullable required

Detected language code (ISO 639-1)

statusstring required

Public status: processing, completed, failed

createdOnstring nullable required

Creation timestamp in ISO 8601 format

modifiedOnstring nullable required

Last modification timestamp in ISO 8601 format

phoneProviderCallIdstring required

External identifier of the call from the phone provider (e.g. Aircall, Ringover, etc.).

recordingRetentionStatus'available' | 'deleted' required

Retention status of the call recording: "available" if the recording is kept, "deleted" if it has been deleted for data retention reasons.

transcriptRetentionStatus'available' | 'deleted' required

Retention status of the call transcript: "available" if the transcript is kept, "deleted" if it has been deleted for data retention reasons.

contactIdsnumber[]

Contact IDs. Present when contacts are not expanded.

dealIdnumber nullable

Deal ID. Present when deal is not expanded.

accountIdnumber nullable

Account ID. Present when account is not expanded.

userIdsnumber[]

User IDs. Present when users are not expanded.

Example response

{
  "id": 1,
  "name": "Demo call with Acme Corp",
  "date": "2024-06-15T14:30:00.000Z",
  "duration": 1800,
  "direction": "outbound",
  "language": "en",
  "status": "completed",
  "createdOn": "2024-06-15T14:30:00.000Z",
  "modifiedOn": "2024-06-15T15:00:00.000Z",
  "phoneProviderCallId": "aircall-1234567890",
  "recordingRetentionStatus": "available",
  "transcriptRetentionStatus": "available",
  "contacts": [
    {
      "id": 10,
      "name": "John Smith",
      "email": "john@prospect.com",
      "phoneNumber": "+33612345678",
      "jobTitle": "VP of Sales"
    }
  ],
  "deal": {
    "id": 100,
    "name": "Acme Corp - Enterprise Plan",
    "status": "open",
    "stage": "Negotiation",
    "amount": 50000,
    "currency": "EUR",
    "closeDate": "2024-09-30"
  },
  "dealId": 100,
  "account": {
    "id": 200,
    "name": "Acme Corp"
  },
  "accountId": 200,
  "users": [
    {
      "id": 42,
      "email": "jane.doe@company.com",
      "firstName": "Jane",
      "lastName": "Doe"
    }
  ],
  "crmActivity": {
    "crmId": "00T1234567ABC",
    "crmOrigin": "created_by_modjo"
  }
}

Changes