Skip to main content
GET
/
v1
/
calls
List Calls
curl --request GET \
  --url https://api.example.com/v1/calls \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "org_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "assistant_id": "<string>",
      "phone_number_id": "<string>",
      "type": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "summary": "<string>",
      "customer_number": "<string>",
      "status": "pending",
      "category": "client_support",
      "duration_min": 123,
      "patient_id": "<string>",
      "language": "english",
      "sessions_scheduled": 123
    }
  ],
  "pagination": {
    "has_more": true,
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
page
integer | null
default:1
Required range: x >= 1
​
limit
integer | null
default:50
Required range: 1 <= x <= 100
​
q
string | null
​
assistant_id
string | null
​
status
enum<string> | null

Call status enum matching Prisma @map values

Available options:
pending,
done,
follow_up_needed
​
category
enum<string> | null

Call category enum matching Prisma @map values

Available options:
client_support,
miscellaneous,
billing,
new_appointment,
existing_appointment,
rescheduling,
cancellation,
authorization,
appointment_inquiry
​
type
string | null
​
customer_number
string | null
​
patient_id
string | null
​
sessions_scheduled_min
integer | null
​
tag_filter_mode
enum<string> | null
default:any

Tag filter mode for patient queries

Available options:
any,
all,
exclude_any,
exclude_all
​
started_gte
string<date-time> | null
​
started_lte
string<date-time> | null

Response

Successful Response

​
data
CallResponse · object[]
required
​
pagination
Pagination · object
required

Pagination information for list responses.

Fields:

  • has_more: Whether more items exist beyond this page
  • total: Total number of items across all pages
  • page: Current page number (1-based)
  • limit: Number of items per page