Skip to main content
GET
Get a call

Authorizations

Authorization
string
header
required

Enter your API Key (sk_live_xxx or sk_test_xxx)

Path Parameters

id
string
required

Response

The call

id
string
required

Unique identifier of the call history entry

Example:

"123e4567-e89b-12d3-a456-426614174000"

callType
enum<string>
required

Type of the call history entry (e.g., CALL_SESSION, DIRECT_CALL)

Available options:
CALL_SESSION,
DIRECT_CALL
Example:

"CALL_SESSION"

status
string
required

Status of the call

Example:

"completed"

type
string
required

Type of call (e.g., outbound, inbound)

Example:

"outbound"

startedAt
object | null
required

Start time of the call

Example:

"2024-03-20T09:00:00.000Z"

endedAt
object | null
required

End time of the call

Example:

"2024-03-20T09:15:00.000Z"

createdAt
string<date-time>
required

Date and time when the call history entry was created

Example:

"2024-03-20T08:55:00.000Z"

contact
object | null
required

Contact information associated with the call

phoneNumber
object | null
required

Phone number information associated with the call

caller
object | null
required

Caller information (organization member who made the call)

callerPhoneNumber
object | null
required

Managed phone number used by the caller

phoneNumberId
string

Unique identifier of the phone number used for the call

Example:

"123e4567-e89b-12d3-a456-426614174002"

userProviderSid
string

Provider SID for the user side of the call

Example:

"CA123456789"

adminProviderSid
object | null

Provider SID for the admin side of the call

Example:

"CA987654321"

providerConferenceId
string

Provider conference ID

Example:

"CF123456789"

transferred
boolean

Indicates if the call was transferred

Example:

false

updatedAt
string<date-time>

Date and time when the call history entry was last updated

Example:

"2024-03-20T09:16:00.000Z"

sequenceRunId
string

Unique identifier of the related sequence run

Example:

"123e4567-e89b-12d3-a456-426614174003"

sequenceId
string

Unique identifier of the parent sequence

Example:

"123e4567-e89b-12d3-a456-426614174010"

syncedWithCrmDate
object | null

Date and time when the call was synced with CRM

Example:

"2024-03-20T09:15:00.000Z"

deletedAt
string<date-time> | null

Date and time when the call history entry was deleted

Example:

"2024-03-20T09:15:00.000Z"

organizationId
string

Unique identifier of the organization

Example:

"123e4567-e89b-12d3-a456-426614174004"

organizationMembershipId
string

Unique identifier of the organization membership

Example:

"123e4567-e89b-12d3-a456-426614174005"

managedPhoneNumberId
string

Unique identifier of the managed phone number

Example:

"123e4567-e89b-12d3-a456-426614174006"

notes
string

Notes associated with the call

Example:

"Call notes here"