v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Treatment Note

List treatment notes

get/treatment_notes

Query parameters

pageinteger

per_pageinteger

sortstring[]

Comma separated search fields. See: Ordering

[
  "created_at:desc"
]

order'asc' | 'desc'

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
attendee_id	int64
booking_id	int64
created_at	date-time
deleted_at	date-time
draft	boolean
id	int64
patient_id	int64
practitioner_id	int64
treatment_note_template_id	int64
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "treatment_notes": [
    {
      "attendee": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1"
        }
      },
      "booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "content": {
        "sections": [
          {
            "questions": [
              {
                "body_chart_ids": [
                  "1"
                ]
              }
            ]
          }
        ]
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/treatment_notes/1"
      },
      "patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1"
        }
      },
      "practitioner": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/practitioners/1"
        }
      },
      "treatment_note_template": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
        }
      }
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/treatment_notes?page=2",
    "previous": "https://api.au1.cliniko.com/v1/treatment_notes?page=1",
    "next": "https://api.au1.cliniko.com/v1/treatment_notes?page=3"
  }
}