Skip to content
API reference
/
/
List treatments

List treatments

Request

Returns a paginated list of treatments for the practice identified by X-Practice-Id. Treatments are the practice-level catalogue of procedures that can be assigned to a patient treatment plan.

Practice-wide: treatments belong to the practice as a whole, not to a site. This endpoint does not accept a site_id filter, and every treatment for the practice is returned, whichever site a treatment is used at.

Results are ordered by creation time, latest first (created_at descending), then by id descending for a stable sort.

Optional query parameter is_active, when true, restricts results to active treatments. When false, restricts results to inactive treatments. When omitted, all treatments are returned.

Optional date filters (created_date_from, created_date_to, updated_date_from, updated_date_to) restrict results by creation or last update date. When omitted, the whole catalogue is returned.

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.

is_activeboolean
  • When true, only records with active: true are returned.
  • When false, only records with active: false are returned.
  • When omitted, all records are returned.
Example:is_active=true
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
treatment_category_idstring, (uuid)

Filter treatments to those in the specified treatment category. The value should be a UUID.

Example:treatment_category_id=4ee0fa3e-12f4-4942-9347-1702eb89ebcc
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/treatments?limit=20&cursor=string&is_active=true&created_date_from=2026-01-01&created_date_to=2026-01-01&updated_date_from=2026-01-01&updated_date_to=2026-01-01&treatment_category_id=4ee0fa3e-12f4-4942-9347-1702eb89ebcc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Paginated list of treatments for the requested practice.

Bodyapplication/json
dataArray of objects(treatment)required

Treatments 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. Includes a practice-authored treatment and a Dentally-managed system treatment.

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