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

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": "completed",
      "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"
        }
      ],
      "from_number": "+33912345678",
      "to_number": "+33612345678",
      "direction": "inbound",
      "recording_url": "<string>"
    }
  ],
  "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.

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

200

application/json

Successfully retrieved calls

data

object[]

required

List of call objects matching the query criteria.

data.id

string

required

Unique identifier for the call.

Example:

"123e4567-e89b-12d3-a456-426614174000"

data.status

enum<string>

required

Current status of the call.

Available options:

queued,

initiated,

ringing,

connected,

in_progress,

completed,

redirection_completed,

busy,

no_answer,

canceled,

failed

data.from_number

string

required

Phone number that initiated the call.

Example:

"+33912345678"

data.to_number

string

required

Phone number that received the call.

Example:

"+33612345678"

data.direction

enum<string>

required

Direction of the call (inbound or outbound)

Available options:

inbound,

outbound

data.organization_id

string | null

ID of the organization the call belongs to.

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.type

enum<string>

Indicates this is a phone call.

Available options:

phone_call,

web_call

data.agent_id

string | null

ID of the agent handling the call.

Example:

"123e4567-e89b-12d3-a456-426614174002"

data.metadata

object | null

Additional metadata associated with the call.

Example:

{
  "source": "marketing_campaign",
  "utm_medium": "email"
}

data.start_time

string | null

Timestamp when the call started.

Example:

"2023-06-15T14:30:00Z"

data.end_time

string | null

Timestamp when the call ended.

Example:

"2023-06-15T14:35:00Z"

data.duration_seconds

integer | null

Duration of the call in seconds.

Example:

300

data.redirect_duration_seconds

integer | null

Duration of call redirection in seconds.

Example:

5

data.cost

number | null

Estimation of the cost of the call in EUR.

Example:

0.15

data.transcript_string

string | null

Plain text representation of the call transcript.

Example:

"Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status."

data.transcript

object[] | null

Structured representation of the call transcript with messages and tool calls.

Response schema for regular message content.

data.variable_values

object[] | null

Values of variables collected during the call.

API response schema for variable values. This schema is used in the call response.

data.recording_url

string | null

A temporary URL to access the call recording that expires after 1 hour. Returns null if no recording exists or if recording failed.

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

Update call Terminate call

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": "completed",
      "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"
        }
      ],
      "from_number": "+33912345678",
      "to_number": "+33612345678",
      "direction": "inbound",
      "recording_url": "<string>"
    }
  ],
  "message": "Calls retrieved successfully",
  "status": 200,
  "next_cursor": "<string>",
  "current_page": 123,
  "total_pages": 123,
  "total_items": 123
}

calls

knowledge bases

Authorizations

Query Parameters

Response