Skip to content
/Treatment Plans

Treatment Plans

Planned course of dental treatment for a patient at a practice.

Operations

List treatment plans

Request

Returns a paginated list of treatment plans for the practice identified by X-Practice-Id. Results are ordered by creation time, newest first (created_at descending), then by id descending for a stable sort.

Optional query parameters allow filtering by patient, practitioner, site, start date, completed date, created/updated date ranges and if the treatment plan is completed.

When is_completed is true, results are restricted to plans that are completed. When false, results are restricted to plans that have not been completed. When omitted, all treatment plans are returned.

Date range. Optional query parameters created_date_from and created_date_to filter by creation date, while updated_date_from and updated_date_to filter by update date. Additionally, start_date_from and start_date_to filter by start date, and completed_date_from and completed_date_to filter by completed at date. Both ends are inclusive.

Use limit and the meta.cursor value from the response to retrieve further pages.

Security
oauth2(Required scopes: treatment:read)
Query
limitinteger, [ 1 .. 100 ]

Maximum number of records to return per page.

Default:20
cursorstring

Cursor reference to the next page of records.

site_idstring, (uuid)

Filter records to those occurring at the specified site. The value should be a UUID corresponding to a site within the practice.

practitioner_idstring, (uuid)

Filter records to those associated with the specified practitioner. The value should be a UUID corresponding to a practitioner within the practice.

created_date_fromstring, (date)

Inclusive start of a created date range filter. Calendar date only (YYYY-MM-DD). Use together with created_date_to for explicit date range control.

  • When used together with created_date_to, the range between the two values must not exceed 90 days.
  • When used without created_date_to, returns records from created_date_from up to 90 days later (or up to the current date-time if it is earlier).
Example:created_date_from=2026-01-01
created_date_tostring, (date)

Inclusive end of a created date range filter. Calendar date only (YYYY-MM-DD). Use together with created_date_from for explicit date range control.

  • When used together with created_date_from, the range between the two values must not exceed 90 days.
  • When used without created_date_from, returns records from 90 days before created_date_to (or from the earliest available date if less than 90 days of data exists) up to created_date_to.
Example:created_date_to=2026-01-01
updated_date_fromstring, (date)

Inclusive start of an updated date range filter. Calendar date only (YYYY-MM-DD). Use together with updated_date_to for explicit date range control.

  • When used together with updated_date_to, the range between the two values must not exceed 90 days.
  • When used without updated_date_to, returns records from updated_date_from up to 90 days later (or up to the current date-time if it is earlier).
Example:updated_date_from=2026-01-01
updated_date_tostring, (date)

Inclusive end of an updated date range filter. Calendar date only (YYYY-MM-DD). Use together with updated_date_from for explicit date range control.

  • When used together with updated_date_from, the range between the two values must not exceed 90 days.
  • When used without updated_date_from, returns records from 90 days before updated_date_to (or from the earliest available date if less than 90 days of data exists) up to updated_date_to.
Example:updated_date_to=2026-01-01
patient_idstring, (uuid)

Filter treatment plans to those associated with the specified patient. The value should be a UUID corresponding to a patient within the practice.

is_completedboolean

Filter treatment plans to those those that have been completed or incompleted.

start_date_fromstring, (date)

Inclusive start of the start date range (YYYY-MM-DD). Use together with start_date_to for explicit date range control.

  • When used together with start_date_to, the range between the two values must not exceed 90 days.
  • When used without start_date_to, returns records from start_date_from up to 90 days later (or up to the current date if it is earlier).
Example:start_date_from=2025-01-01
start_date_tostring, (date)

Inclusive end of the start date range (YYYY-MM-DD). Use together with start_date_from for explicit date range control. - When used together with start_date_from, the range between the two values must not exceed 90 days. - When used without start_date_from, returns records from 90 days before start_date_to (or from the earliest available date if less than 90 days of data exists) up to start_date_to.

Example:start_date_to=2025-03-31
completed_date_fromstring, (date)

Inclusive start of the completed date range (YYYY-MM-DD). Use together with completed_date_to for explicit date range control.

  • When used together with completed_date_to, the range between the two values must not exceed 90 days.
  • When used without completed_date_to, returns records from completed_date_from up to 90 days later (or up to the current date if it is earlier).
Example:completed_date_from=2025-01-01
completed_date_tostring, (date)

Inclusive end of the completed date range (YYYY-MM-DD). Use together with completed_date_from for explicit date range control.

  • When used together with completed_date_from, the range between the two values must not exceed 90 days.
  • When used without completed_date_from, returns records from 90 days before completed_date_to (or from the earliest available date if less than 90 days of data exists) up to completed_date_to.
Example:completed_date_to=2025-03-31
Headers
X-Practice-Idstring, (uuid)required

UUID of the practice in whose context the request is executed. The API uses this to resolve data the caller is permitted to access for that practice.

curl -i -X GET \
  'https://docs.api.dentally.com/_mock/docs/versions/2026-01-01/nexgen/treatment_plans?limit=20&cursor=string&site_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&practitioner_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&created_date_from=2026-01-01&created_date_to=2026-01-01&updated_date_from=2026-01-01&updated_date_to=2026-01-01&patient_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&is_completed=true&start_date_from=2025-01-01&start_date_to=2025-03-31&completed_date_from=2025-01-01&completed_date_to=2025-03-31' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Paginated list of treatment plans for the requested practice.

Bodyapplication/json
dataArray of objects(treatment-plan)required

Treatment Plans in the current page.

metaobject(meta)required

Cursor-based pagination metadata. When an operation supports paging, pass cursor from this object on a subsequent request to continue after the current page.

Response

Paginated list with cursor for the next page.

{
  "data": [
    { … }
  ],
  "meta": {
    "cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNS0wOC0xMlQxMTowMDowMFoifQ"
  }
}