Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Input your token

Headers

Tenant-Name
string
required

Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request.

Example:

"base"

Query Parameters

sort
enum<string>
default:createdAt

Field used to sort interactions. Default is createdAt.

Available options:
id,
assignedUserId,
patient,
createdAt,
endedAt,
updatedAt
direction
enum<string>

Sorting order. Allowed values: [asc, desc]. Default is desc.

Available options:
asc,
desc
Example:

"desc"

pageSize
integer<int64>

Number of interactions to return per page. Must be greater than 0. Default is 10.

index
integer<int64>

Page number to retrieve. Starts at 1. For example, index=2 with pageSize=10 will return interactions 11–20. Must be greater than 0. Default is 1.

encounterStatus
enum<string>[]

The status of the encounter. To filter on multiple statuses, pass the same parameter again.

Available options:
planned,
in-progress,
on-hold,
completed,
cancelled,
deleted
patient
string

A unique identifier for the patient.

Response

interactions
object[]
required