List calls

Fetch a paginated list of calls associated with a specific Quo number and another number.

GET /v1/calls

List calls

cURL

curl --request GET \
  --url https://dev-public-api.openphone.dev/v1/calls \
  --header 'Authorization: <api-key>'

200

{
  "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",
      "callRoute": "phone-number",
      "duration": 60,
      "forwardedFrom": "US123abc",
      "forwardedTo": "US123abc",
      "aiHandled": "ai-agent",
      "id": "AC123abc",
      "phoneNumberId": "PN123abc",
      "participants": [
        "[phone]"
      ],
      "updatedAt": "2022-01-01T00:00:00Z",
      "userId": "US123abc"
    }
  ],
  "totalItems": 123,
  "nextPageToken": "<string>"
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "description": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

{
  "message": "<string>",
  "code": "<string>",
  "status": 123,
  "docs": "<string>",
  "title": "<string>",
  "trace": "<string>",
  "errors": [
    {
      "path": "<string>",
      "message": "<string>",
      "schema": {
        "type": "<string>"
      },
      "value": "<unknown>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Query Parameters

phoneNumberId · string · required

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

Pattern: ^PN(.*)$

Example:

"PN123abc"

userId · string

The unique identifier of the user whose access scope is applied to the results. Scopes the response to calls accessible to the specified user. Defaults to the workspace owner.

Pattern: ^US(.*)$

Example:

"US123abc"

participants · string[] · required

The phone numbers of participants involved in the call conversation, excluding your Quo 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.

Maximum array length: 1

Minimum string length: 1

Example:

"[phone]"

since · string<date-time> · deprecated

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

Example:

"2022-01-01T00:00:00Z"

createdAfter · string<date-time>

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

Example:

"2022-01-01T00:00:00Z"

createdBefore · string<date-time>

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

Example:

"2022-01-01T00:00:00Z"

maxResults · integer · default: 10 · required

Maximum number of results to return per page.

Required range: 1 <= x <= 100

pageToken · string

Response

200

application/json

OK

data · object[] · required

Show child attributes

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