List calls

GET

calls

curl --request GET \
  --url https://api.openphone.com/v1/calls

{
  "data": [
    {
      "answeredAt": "2022-01-01T00:00:00Z",
      "answeredBy": "USlHhXmRMz",
      "initiatedBy": "USlHhXmRMz",
      "direction": "incoming",
      "status": "completed",
      "completedAt": "2022-01-01T00:00:00Z",
      "createdAt": "2022-01-01T00:00:00Z",
      "duration": 60,
      "forwardedFrom": "US123abc",
      "forwardedTo": "US123abc",
      "id": "AC123abc",
      "phoneNumberId": "PN123abc",
      "participants": [
        "+15555555555"
      ],
      "updatedAt": "2022-01-01T00:00:00Z",
      "userId": "US123abc"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

Query Parameters

phoneNumberId

string

required

The unique identifier of the OpenPhone number associated with the call.

userId

string

The unique identifier of the OpenPhone user who either placed or received the call. Defaults to the workspace owner.

participants

string[]

required

The phone numbers of participants involved in the call conversation, excluding your OpenPhone number. Each number should contain the country code and conform to the E.164 format. Currently limited to one-to-one (1:1) conversations only.

since

string

deprecated

DEPRECATED, use "createdAfter" or "createdBefore" instead. "since" incorrectly behaves as "createdBefore" and will be removed in an upcoming release.

createdAfter

string

Filter results to only include calls created after the specified date and time, in ISO 8601 format.

createdBefore

string

Filter results to only include calls created before the specified date and time, in ISO 8601 format.

maxResults

integer

default:

required

Maximum number of results to return per page.

Required range: 1 <= x <= 100

pageToken

string

Response

200

application/json

Success

data

object[]

required

Array of items

A call object represents a call made or received by your OpenPhone phone number.

data.answeredAt

string | null

required

The timestamp when the call was answered in ISO 8601 format. Null if the call was not answered.

data.answeredBy

string | null

required

The unique identifier of the OpenPhone user who answered the incoming call. Null for outgoing calls or unanswered incoming calls.

data.initiatedBy

string | null

required

The unique identifier of the OpenPhone user who initiated the outgoing call. Null for incoming calls.

data.direction

enum<string>

required

The direction of the call relative to the OpenPhone number.

Available options:

incoming,

outgoing

data.status

enum<string>

required

The current status of the call.

Available options:

queued,

initiated,

ringing,

in-progress,

completed,

busy,

failed,

no-answer,

canceled,

missed,

answered,

forwarded,

abandoned

data.completedAt

string | null

required

The timestamp when the call ended, in ISO 8601 format. Null if the call is ongoing or was not completed.

data.createdAt

string

required

The timestamp when the call record was created, in ISO 8601 format.

data.duration

integer

required

The total duration of the call in seconds.

data.forwardedFrom

required

The phone number or OpenPhone user ID from which the call was forwarded. Null if the call was not forwarded.

data.forwardedTo

required

The phone number or OpenPhone user ID to which the call was forwarded. Null if the call was not forwarded.

data.id

string

required

The unique identifier of the call.

data.phoneNumberId

string

required

The unique identifier of the OpenPhone number associated with the call.

data.participants

string[]

required

An array of phone numbers involved in the call, including the OpenPhone number. Each number includes the country code and conforms to the E.164 format. Currently limited to one-to-one conversations.

A phone number in E.164 format, including the country code.

data.updatedAt

string | null

required

The timestamp when the call record was last updated, in ISO 8601 format. Null if never updated.

data.userId

string

required

The unique identifier of the OpenPhone user account associated with the call.

totalItems

integer

required

Total number of items available. ⚠️ Note: totalItems is not accurately returning the total number of items that can be paginated. We are working on fixing this issue.

nextPageToken

string | null

required

Was this page helpful?

Rate limits Get recordings for a call

curl --request GET \
  --url https://api.openphone.com/v1/calls

{
  "data": [
    {
      "answeredAt": "2022-01-01T00:00:00Z",
      "answeredBy": "USlHhXmRMz",
      "initiatedBy": "USlHhXmRMz",
      "direction": "incoming",
      "status": "completed",
      "completedAt": "2022-01-01T00:00:00Z",
      "createdAt": "2022-01-01T00:00:00Z",
      "duration": 60,
      "forwardedFrom": "US123abc",
      "forwardedTo": "US123abc",
      "id": "AC123abc",
      "phoneNumberId": "PN123abc",
      "participants": [
        "+15555555555"
      ],
      "updatedAt": "2022-01-01T00:00:00Z",
      "userId": "US123abc"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

Getting started

Essentials

Calls

Contact Custom Fields

Contacts

Conversations

Messages

Phone Numbers

Webhooks

Query Parameters

Response