Appointment Reasons

Reasons that describe the purpose of a patient visit (for example an examination or a scale and polish). List and retrieve the catalogue of reasons configured for a practice.

Operations

List appointment reasons

Request

Returns a paginated list of appointment reasons for the practice identified by X-Practice-Id. 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 appointment reasons that are currently active. When false, restricts results to appointment reasons that are currently inactive. When omitted, all appointment reasons are returned.

Security

oauth2(Required scopes: appointment: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

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/appointment_reasons?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' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-Practice-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

The list of appointment reasons.

Bodyapplication/json

dataArray of objects(appointment-reason)required

List of appointment reasons.

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": "eyJjdXJzb3IiOiJuZXh0In0"
  }
}