v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Interactions

List All Interactions

Lists all existing interactions. Results can be filtered by encounter status and patient identifier.

get/interactions/

Query parameters

sort'id' | 'assignedUserId' | 'patient' | 'createdAt' | 'endedAt' | 'updatedAt'

Field used to sort interactions. Default is createdAt.

Field used to sort interactions. Default is createdAt.

direction'asc' | 'desc'
Example:desc

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

pageSizeinteger

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

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

indexinteger

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.

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.

encounterStatusInteractionsEncounterStatusEnum[]

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

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

patientstring

A unique identifier for the patient.

A unique identifier for the patient.

Headers

Tenant-Namestring required

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

Example:base

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

Response

Example response

{
  "interactions": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "assignedUserId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    }
  ]
}