GET
/
call
curl --request GET \
  --url https://api.clarionhealth.com/v1/call \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "assistant_id": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "call_status": "queued",
    "ended_reason": "<string>",
    "transcript": "<string>",
    "source_number": "<string>",
    "destination_number": "<string>",
    "call_type": "<string>",
    "messages": [
      {
        "role": "<string>",
        "message": "<string>",
        "time": 123,
        "endTime": 123,
        "secondsFromStart": 123,
        "duration": 123
      }
    ],
    "duration_ms": 123,
    "analysis": {
      "structuredData": {},
      "successEvaluation": "<string>"
    },
    "summary": "<string>",
    "outcome": "<string>",
    "failure_reason": "declined"
  }
]

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
integer

The maximum number of results to return. Defaults to 100, maximum is 1000.

createdAtGe
string

Filter calls created on or after this date (ISO 8601 format)

createdAtLe
string

Filter calls created on or before this date (ISO 8601 format)

Response

200 - application/json

List Calls

The response is of type object[].