Treatments

Get a Treatment

Changed on

Returns a treatment by its ID.

get/api/2026-01-01/treatments/{id}

Request

  • Base URL
    https://jdpdocsdemo.jane.qa
  • URL
    https://jdpdocsdemo.jane.qa/api/2026-01-01/treatments/{id}
  • Auth
    OAuth 2
    Authorization code: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/auth?response_type=code&resource=https://jdpdocsdemo.jane.qa&prompt=consent
    Token URL: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/token scopes: treatments:read

Path parameters

idstring uuid required

The ID of the treatment

Response

Treatment retrieved successfully

idstring uuid

The unique identifier for the treatment

namestring

The name of the treatment

descriptionstring nullable

A description of the treatment

treatment_durationinteger

The duration of the treatment in seconds

scheduled_durationinteger

The scheduled duration of the treatment in seconds, may include buffer time

pricenumber float

The price of the treatment

display_priceboolean

Whether the price is displayed to customers

capacityinteger

The maximum number of patients that can be booked for this treatment

booking_type'one_on_one_booking' | 'class_booking' | 'group_booking'

The type of booking

booking_infostring nullable

Additional information about booking this treatment

discipline_idstring uuid nullable

The public ID of the discipline associated with this treatment

online_onlyboolean

Whether this treatment is offered online only

book_onlineboolean

Whether this treatment can be booked online

display_treatment_durationboolean

Whether the treatment duration is displayed to customers

price_includes_taxboolean

Whether the price includes tax

color'jane-blue' | 'butter' | 'lavender' | 'tangerine' | 'dusk' | 'moss' | 'lilac' | 'flamingo' | 'mint' | 'mauve'

The treatment's display color, as a human-readable slug from a fixed palette of 10 values.

Hex values for rendering: jane-blue: #00c1ca | butter: #efd59a | lavender: #c4c4d6 | tangerine: #f1b37a | dusk: #8eb8c9 | moss: #8ea785 | lilac: #d1a6c5 | flamingo: #e8a2b6 | mint: #a5d7c5 | mauve: #c38f92

Changes