Calls

Access voice call records and download call recordings.

The Calls API provides read access to voice call records associated with patients. You can retrieve call metadata, access recordings, and download audio files.

Note: To access call recordings, your API client's Security Policy must include the Voice Calls None Care Team permission.

Base path: /{tenantName}/{instanceName}/patients/{patientId}/calls

---

Endpoints

GET Get All Voice Calls

GET /{tenantName}/{instanceName}/patients/{patientId}/calls

Returns all voice call records for a patient.

Path Parameters

Parameter	Type	Required	Description
patientId	string	Yes	Welkin patient UUID

Query Parameters

Parameter	Type	Default	Description
page	integer	0	Page number
size	integer	20	Results per page
startDate	string	—	Filter calls on or after this date (ISO 8601)
endDate	string	—	Filter calls on or before this date (ISO 8601)

Example Request

GET /acme-health/live/patients/a1b2c3d4/calls
Authorization: Bearer <token>

Example Response 200 OK

{
  "data": [
    {
      "id": "call-uuid",
      "patientId": "a1b2c3d4",
      "direction": "OUTBOUND",
      "duration": 245,
      "status": "COMPLETED",
      "calledAt": "2026-03-18T14:22:00Z",
      "hasRecording": true
    }
  ],
  "metaInfo": { "page": 0, "pageSize": 20, "totalElements": 8 }
}

---

GET Get Voice Call by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/calls/{callId}

Returns a single voice call record with full metadata.

Path Parameters

Parameter	Type	Required	Description
patientId	string	Yes	Welkin patient UUID
callId	string	Yes	Call record UUID

---

GET Download Recording File

GET /{tenantName}/{instanceName}/patients/{patientId}/calls/{callId}/recording

Returns the audio recording file for a completed call.

Response

Header	Value
Content-Type	audio/mpeg or audio/wav
Content-Disposition	attachment; filename="recording-{callId}.mp3"

Recordings are only available for calls where hasRecording: true.