Skip to main content
GET
/
v1
/
calls
List calls
curl --request GET \
  --url https://api.callrounded.com/v1/calls \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organization_id": "123e4567-e89b-12d3-a456-426614174001",
      "type": "phone_call",
      "agent_id": "123e4567-e89b-12d3-a456-426614174002",
      "status": "created",
      "metadata": {
        "source": "marketing_campaign",
        "utm_medium": "email"
      },
      "start_time": "2023-06-15T14:30:00Z",
      "end_time": "2023-06-15T14:35:00Z",
      "duration_seconds": 300,
      "redirect_duration_seconds": 5,
      "cost": 0.15,
      "transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.",
      "transcript": [
        {
          "role": "user",
          "start_time": "2023-06-15T14:31:23Z",
          "content": "Hello, how can I help you today?"
        }
      ],
      "variable_values": [
        {
          "name": "customer_name",
          "type": "string",
          "value": "John Doe",
          "timestamp": "2023-06-15T14:33:12Z"
        }
      ],
      "answer_type": "human",
      "from_number": "+33912345678",
      "to_number": "+33612345678",
      "direction": "inbound",
      "recording_url": "https://rounded-twilio.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be",
      "secure_recording_url": true
    }
  ],
  "message": "Calls retrieved successfully",
  "status": 200,
  "next_cursor": "<string>",
  "current_page": 123,
  "total_pages": 123,
  "total_items": 123
}

Authorizations

​
X-Api-Key
string
header
required

The API Key created in Rounded Studio.

Query Parameters

​
agent_id
string | null

Filter calls by the agent ID that handled them.

​
call_type
enum<string> | null

Filter by call type (e.g., phone_call or web_call).

Available options:
phone_call,
web_call
​
from_number
string | null

Filter by the phone number that initiated the call (E.164 format with + prefix).

​
to_number
string | null

Filter by the destination phone number of the call (E.164 format with + prefix).

​
start_time_gt
string | null

Return only calls with start_time greater than this value (ISO 8601 format).

​
start_time_lt
string | null

Return only calls with start_time less than this value (ISO 8601 format).

​
cursor
string | null

Cursor for pagination (ISO 8601 datetime of last seen record).

​
page
integer | null

Page number for page-based pagination (1-indexed, only used when use_cursor=false).

​
limit
integer | null
default:50

Maximum number of results to return per page (default: 50, max: 1000).

​
use_cursor
boolean | null
default:true

Pagination mode selection: true for cursor-based pagination, false for page-based pagination.

​
include_transcript
boolean | null
default:false

Whether to include transcript data in the response.

​
include_variable_values
boolean | null
default:false

Whether to include variable values in the response.

Response

Successfully retrieved calls

​
data
Data · array
required

List of call objects matching the query criteria.

  • PhoneCallGetApiResponseData
  • WebCallGetApiResponseData
​
message
string
default:Calls retrieved successfully

Response message indicating the status of the request.

​
status
integer
default:200

HTTP status code (200 for successful requests).

​
next_cursor
string | null

Next cursor value for cursor-based pagination (ISO 8601 datetime string, only present when use_cursor=true).

​
current_page
integer | null

Current page number (only present when use_cursor=false).

​
total_pages
integer | null

Total number of pages available (only present when use_cursor=false).

​
total_items
integer | null

Total count of items matching the query criteria (only present when use_cursor=false).

⌘I