GET /api/v2/call

Provides a paginated list of calls matching the specified filter parameters in reverse-chronological order by call start time (i.e. recent calls first)

Note: This API will only include calls that have already concluded.

Added on May 27, 2024 for API v2.

Requires a company admin API key.

Requires scope: calls:list

Rate limit: 1200 per minute.

Servers

Query parameters

Name Type Required Description
started_after Integer No

Only includes calls that started more recently than the specified timestamp. (UTC ms-since-epoch timestamp)

started_before Integer No

Only includes calls that started prior to the specified timestamp. (UTC ms-since-epoch timestamp)

cursor String No

A token used to return the next page of a previous request. Use the cursor provided in the previous response.

target_id Integer No

The ID of a target to filter against.

target_type String No

The target type associated with the target ID.

Possible values:

  • "room"
  • "callrouter"
  • "channel"
  • "coachingteam"
  • "staffgroup"
  • "callcenter"
  • "department"
  • "office"
  • "unknown"
  • "user"
  • "coachinggroup"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.