Skip to main content
GET
/
api
/
v1
/
calls
/
search
Search Calls
curl --request GET \
  --url https://api.example.com/api/v1/calls/search \
  --header 'Authorization: Bearer <token>'
[
  {
    "call_sid": "<string>",
    "to_phone_number": "<string>",
    "customer_phone_number": "<string>",
    "id": 123,
    "assistant_id": 123,
    "status": "<string>",
    "call_meta": {},
    "duration": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z"
  }
]
This endpoint allows you to perform a full-text search across your call records. The search will look for matches in fields like assistant name, phone numbers, and transcript content.

​
Query Parameters

  • q (string, required): The search query. Must be at least 3 characters long.
  • limit (integer, optional, default: 50): The maximum number of search results to return.

​
Response

The response is a JSON array of call objects that match the search query. The structure of each call object is the same as the one returned by the List Calls endpoint.
Response
[
  {
    "id": 101,
    "call_sid": "CAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "assistant_id": 123,
    "to_phone_number": "+15551234567",
    "customer_phone_number": "+15559876543",
    "status": "completed",
    "started_at": "2023-10-30T10:00:00Z",
    "ended_at": "2023-10-30T10:05:00Z",
    "duration": 300,
    "cost": 0.05,
    "metadata": {
      "customer_id": "cust_abc123"
    },
    "created_at": "2023-10-30T10:00:00Z",
    "updated_at": "2023-10-30T10:05:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
q
string
required

Search query (minimum 3 characters)

Minimum string length: 3
​
limit
integer
default:50

Maximum number of results

Required range: 1 <= x <= 200

Response

Successful Response

​
call_sid
string
required
​
to_phone_number
string
required
​
customer_phone_number
string
required
​
id
integer
required
​
assistant_id
integer
required
​
status
string
required
​
call_meta
Call Meta · object
​
duration
integer | null
​
started_at
string<date-time> | null
​
ended_at
string<date-time> | null