GET
/
interactions
curl --request GET \
  --url https://api.{environment}.corti.app/v2/interactions/
{
  "interactions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "encounter": {
        "identifier": "<string>",
        "status": "planned",
        "type": "first_consultation",
        "period": {
          "startedAt": "2023-11-07T05:31:56Z",
          "endedAt": "2023-11-07T05:31:56Z"
        },
        "title": "<string>"
      },
      "patient": {
        "identifier": "<string>",
        "name": "<string>",
        "gender": "male",
        "birthDate": "2023-11-07T05:31:56Z",
        "pronouns": "<string>"
      },
      "endedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "websocketUrl": "<string>",
      "lastUpdated": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
Tenant-Name
string

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

Example:

"copiloteu"

Query Parameters

​
sort
string

Field used to sort interactions. Allowed values: [startedAt, endedAt, updatedAt, lastUpdated]. Default is startedAt.

​
direction
string

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

​
pageSize
integer

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

​
index
integer

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
string

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

​
patient
string

A unique identifier for the patient.

Response

200
application/json
​
interactions
object[]

Was this page helpful?