Skip to main content

Get appointments

GET 
/api/v1/diary/patient/:patientId

Retrieves an array of booked patient appointments.

Response sample

{
  "id": "string",
  "type": "string",
  "appointmentId": "string",
  "appointmentStartTime": "2025-04-29T11:03:20.290Z",
  "pastAppointment": true,
  "isCancelled": true,
  "isNoShow": true,
  "permitAmendment": true,
  "permitAmendmentReason": 0,
  "permitCancellation": true,
  "permitCancellationReason": 0,
  "duration": 0,
  "doctor": {
    "id": "string",
    "type": "string",
    "name": "string",
    "bio": "string",
    "image": {
      "url": "string" },
    "links": {
      "additionalProp1": {
        "href": "string",
        "type": "string" },
      "additionalProp2": {
        "href": "string",
        "type": "string" },
      "additionalProp3": {
        "href": "string",
        "type": "string" }},
    "visitType": {
      "id": "string",
      "type": "string",
      "name": "string",
      "description": "string",
      "defaultDuration": 0,
      "visitTypeGroup": {
        "id": "string",
        "type": "string",
        "groupName": "string",
        "displayOrder": 0 },
      "links": {
        "additionalProp1": {
          "href": "string",
          "type": "string" },
        "additionalProp2": {
          "href": "string",
          "type": "string" },
        "additionalProp3": {
          "href": "string",
          "type": "string" }}},
    "notes": "string",
    "appointmentSiteDetails": {
      "siteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "type": "string",
      "address": {
        "address1": "string",
        "address1Seo": "string",
        "address2": "string",
        "address3": "string",
        "postalCode": "string",
        "city": "string",
        "multilanguageCity": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string" },
        "citySeo": "string",
        "phone": "string",
        "email": "string",
        "country": {
          "countryName": "string",
          "countryIsocode2": "string",
          "countryIsocode3": "string" },
        "county": "string" }}}
}

Request​

Responses​

Success: Request accepted.