List treatment plan items

API reference

Request

Returns a paginated list of treatment plan items for the treatment plan identified by id in the path, within 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 created/updated date ranges.

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. Both ends are inclusive.

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

Security

oauth2(Required scopes: treatment:read)

Path

idstring, (uuid)required

Resource identifier to filter/find.

Query

limitinteger, [ 1 .. 100 ]

Maximum number of records to return per page.

Default:20

cursorstring

Cursor reference to the next page of records.

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

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/{id}/treatment_plan_items?limit=20&cursor=string&created_date_from=2026-01-01&created_date_to=2026-01-01&updated_date_from=2026-01-01&updated_date_to=2026-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Paginated list of treatment plan items for the requested practice.

Bodyapplication/json

dataArray of objects(treatment-plan-item)required

Treatment Plan Items 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"
  }
}