Skip to main content
GET
List receptionist calls
Safety
  • Writes data: No
  • Safe to retry: Yes
  • Contacts an outside system: None
  • Dry run: Not needed (read-only).
Calls are returned newest first by the time HealOS received the call record (created_at), which is what from_date and to_date filter on. Each item carries the status, outcome and post-call summary; the transcript and extracted details are on Get a receptionist call, and the audio on Download a call recording. The id is the same call_id the post-call webhook sends, so you can use the webhook as the trigger and this endpoint to fetch the rest. Guide: Receptionist call transcripts. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Query Parameters

page
string
default:1

Page number, from 1.

Pattern: ^\d+$
Example:

"1"

limit
string
default:20

Results per page, 1-100 (default 20). Larger values are treated as 100.

Pattern: ^\d+$
Example:

"20"

from_date
string

Only calls received at or after this instant (ISO 8601). A date without a time means the start of that day in UTC.

Example:

"2026-10-27"

to_date
string

Only calls received at or before this instant (ISO 8601). A date without a time means the start of that day in UTC, so use the next day or add a time to include a whole day.

Example:

"2026-10-28T23:59:59Z"

outcome
string

Comma-separated call outcomes to include. One or more of: booked, rescheduled, cancelled, could_not_book, transferred, transferred_connected, transferred_not_answered, transferred_unknown, question_answered, message_taken, hung_up, other, not_recorded. An unknown value is a 400.

Example:

"message_taken,could_not_book"

Caller name or phone number to search for.

Maximum string length: 100
Example:

"555-0100"

Response

List of calls

data
object[]
required
meta
object
required