Skip to main content
List visits
curl --request GET \
  --url https://{tenantId}.api.nestmed.com/api/v1/visits \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "visitId": "<string>",
      "episodeId": "<string>",
      "patientId": "<string>",
      "clinicianId": "<string>",
      "visitTypeId": "<string>",
      "visitType": {
        "visitTypeId": "<string>",
        "name": "<string>",
        "discipline": "<string>",
        "serviceCode": "<string>"
      },
      "scheduledDate": "2023-11-07T05:31:56Z",
      "actualDate": "2023-11-07T05:31:56Z",
      "duration": 123,
      "status": "scheduled",
      "location": {},
      "patient": {},
      "clinician": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "totalPages": 123,
    "offset": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20
Required range: x <= 100
​
dateFrom
string<date>

Filter for records created or updated on or after this date (ISO 8601 format: YYYY-MM-DD).

​
dateTo
string<date>

Filter for records created or updated on or before this date (ISO 8601 format: YYYY-MM-DD).

​
status
string
​
clinicianId
string
​
patientId
string
​
visitType
string

Response

200 - application/json

A paginated list of visits.

​
data
object[]
​
pagination
object