List calls

curl --request GET \
  --url https://api.callrounded.com/v1/calls \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.callrounded.com/v1/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.callrounded.com/v1/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.callrounded.com/v1/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.callrounded.com/v1/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "created",
      "from_number": "+33912345678",
      "to_number": "+33612345678",
      "direction": "inbound",
      "organization_id": "123e4567-e89b-12d3-a456-426614174001",
      "type": "phone_call",
      "agent_id": "123e4567-e89b-12d3-a456-426614174002",
      "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"
        }
      ],
      "post_call_answers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "question": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Customer Satisfaction",
            "description": "How satisfied was the customer with the call outcome?",
            "question_type": "text",
            "is_optional": false,
            "question_origin": "system"
          },
          "has_answer": true,
          "answer_text": "The customer expressed satisfaction with the resolution.",
          "answer_number": 8.5,
          "answer_boolean": true,
          "selected_options": [
            {
              "option": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "value": "Very Satisfied"
              }
            }
          ]
        }
      ],
      "answer_type": "human",
      "recording_url": "https://rounded-storage.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
}

calls

List calls

List calls with filtering options. Results are paginated and can be filtered by various parameters. Pagination Options:

Cursor-based pagination (default):
- Set use_cursor=true.
- Provide limit parameter to control results per page (default: 50, max: 1000).
- Response includes next_cursor for subsequent requests.
- Best for efficiently paging through large datasets.
Page-based pagination:
- Set use_cursor=false.
- Provide page and limit parameters.
- Response includes current_page, total_pages, and total_items.
- Best for UIs that need to jump to specific pages.

GET

calls

List calls

curl --request GET \
  --url https://api.callrounded.com/v1/calls \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.callrounded.com/v1/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.callrounded.com/v1/calls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.callrounded.com/v1/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.callrounded.com/v1/calls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "created",
      "from_number": "+33912345678",
      "to_number": "+33612345678",
      "direction": "inbound",
      "organization_id": "123e4567-e89b-12d3-a456-426614174001",
      "type": "phone_call",
      "agent_id": "123e4567-e89b-12d3-a456-426614174002",
      "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"
        }
      ],
      "post_call_answers": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "question": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "Customer Satisfaction",
            "description": "How satisfied was the customer with the call outcome?",
            "question_type": "text",
            "is_optional": false,
            "question_origin": "system"
          },
          "has_answer": true,
          "answer_text": "The customer expressed satisfaction with the resolution.",
          "answer_number": 8.5,
          "answer_boolean": true,
          "selected_options": [
            {
              "option": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "value": "Very Satisfied"
              }
            }
          ]
        }
      ],
      "answer_type": "human",
      "recording_url": "https://rounded-storage.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.

You can create it by going to the "API Keys" settings of your profile.
Need help? You can email us at team@callrounded.com or join our Discord community.

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

(PhoneCallGetApiResponseData · object | WebCallGetApiResponseData · object)[]

required

List of call objects matching the query criteria.

PhoneCallGetApiResponseData
WebCallGetApiResponseData

Show child attributes

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).

calls

knowledge bases

agents

phone-numbers

post-call-questions

List calls

Authorizations

Query Parameters

Response