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",
          "startedAtTzoffset": "+00:00",
          "endedAt": "2023-11-07T05:31:56Z",
          "endedAtTzoffset": "+00:00"
        },
        "title": "<string>"
      },
      "patient": {
        "identifier": "<string>",
        "name": "<string>",
        "gender": "male",
        "birthDate": "2023-11-07T05:31:56Z",
        "pronouns": "<string>"
      },
      "endedAt": "2023-11-07T05:31:56Z",
      "endedAtTzoffset": "+00:00",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdAtTzoffset": "+00:00",
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedAtTzoffset": "+00:00",
      "websocketUrl": "<string>",
      "lastUpdated": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
Tenant-Name
string

Query Parameters

​
pageSize
integer

The number of interactions to return. For example, a pageSize of 10 will return a maximum of 10 interactions.

​
index
integer

The number of interactions to skip. For example, index=2 with pageSize=10 will skip the first 10 interactions and return 11-20.

​
encounterStatus
string

The status of the encounter. To filter on multiple statuses, pass the same parameter again (e.g. encounterStatus=in-progress&encounterStatus=completed). The options are: planned, in-progress, on-hold, completed, cancelled, deleted.

​
patientId
string

A unique identifier for the patient.

Response

200
application/json
​
interactions
object[]

Was this page helpful?

Create Interaction