---
title: "Get public settings"
method: GET
path: "/settings/public"
tags: ["Public Settings"]
---

# Get public settings

`GET /settings/public`

## Response `200`

Successful operation

- PublicSettings
  - `account` object, nullable
    - `country` string
    - `country_code` string — [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) country code
    - `currency_symbol` string
    - `has_time_travelers` boolean
    - `id` string, int64
    - `name` string
    - `subdomain` string
    - `time_zone_support` boolean
  - `calendar` object, nullable
    - `end_hour` integer
    - `multiple_appointments_gap` boolean
    - `show_current_time_indicator` boolean
    - `start_hour` integer
    - `timeslot_height_in_pixels` integer
    - `timeslot_size_in_minutes` integer
  - `documents_and_printing` object, nullable
    - `logo_height` integer
    - `logo_url` string, uri, nullable
  - `integrations` object, nullable
    - `mail_chimp` object
      - `enabled` boolean
    - `xero` object
      - `enabled` boolean
  - `online_bookings` object, nullable
    - `allow_bookings_days_in_advance` integer
    - `allow_online_bookings_time_zone_choice` boolean
    - `booking_reservation_minutes` integer
    - `calendar_info` string, nullable
    - `daily_bookings_limit` integer
    - `disabled_text` string, nullable
    - `disabled_title` string, nullable
    - `enabled` boolean
    - `logo_url` string, uri, nullable
    - `max_appointments_per_day_segment` integer
    - `min_hours_advance_required_to_book` integer
    - `min_hours_notice_for_patient_cancellation` integer
    - `notice_enabled` boolean
    - `notice_text` string, nullable
    - `notice_title` string, nullable
    - `notify_practitioner_by_email` boolean
    - `notify_practitioner_by_sms` boolean
    - `policy` string, nullable
    - `practitioner_order` string[], nullable
    - `privacy_policy_url` string, uri, nullable
    - `require_patient_address` boolean
    - `show_appointment_duration` boolean
    - `show_prices` boolean
  - `online_payments` object, nullable
    - `activated` boolean
  - `patient_custom_fields_definition` object, nullable
    - `sections` object[], required
      - `name` string, required
      - `token` string, uuid, required
      - `archived` boolean
      - `fields` union[], required
        - union
          - PatientCustomFieldDefinitionText
            - `archived` boolean
            - `name` string, required
            - `token` string, uuid, required
            - `type` 'text', nullable, required
          - PatientCustomFieldDefinitionParagraph
            - `archived` boolean
            - `name` string, required
            - `token` string, uuid, required
            - `type` 'paragraph', nullable, required
          - PatientCustomFieldDefinitionDate
            - `archived` boolean
            - `name` string, required
            - `token` string, uuid, required
            - `type` 'date', nullable, required
          - PatientCustomFieldDefinitionCheckboxes
            - `options` object[], required
              - …
            - `other` object
              - …
            - `archived` boolean
            - `name` string, required
            - `token` string, uuid, required
            - `type` 'checkboxes', nullable, required
          - PatientCustomFieldDefinitionRadiobuttons
            - `options` object[], required
              - …
            - `other` object
              - …
            - `archived` boolean
            - `name` string, required
            - `token` string, uuid, required
            - `type` 'radiobuttons', nullable, required
  - `patient_privacy` object, nullable
    - `browser_title_name_format` 'first_name' | 'full_name' | 'initials' | 'anonymous' | 'semi_anonymous'
    - `ical_patient_name_option` 'first_name' | 'full_name' | 'initials' | 'anonymous' | 'semi_anonymous'
    - `prevent_sending_financial_data_by_email` boolean
    - `prevent_sending_treatment_notes_by_email` boolean
    - `requires_hipaa_compliance` boolean
  - `reminders` object, nullable
    - `default_reminder_type` 'None' | 'SMS' | 'Email' | 'SMS & Email' — Please use the `default_reminders_communication_channels_description` attribute instead.
    - `default_reminders_communication_channels` integer[] — The array of communication channels that will be used for new patient reminders. | Enum Value | Description | |---|---| | 1 | SMS | | 2 | Email |
    - `default_reminders_communication_channels_description` 'None' | 'SMS' | 'Email' | 'SMS & Email'
  - `sms` object, nullable
    - `alphanumeric_source_number_required` boolean
    - `default_alphanumeric_source_number` string
    - `max_message_length` integer, nullable
    - `number_of_usable_characters_per_message` integer
    - `replies_supported` boolean
  - `terminology` object, nullable
    - `patient` 'patient' | 'client'
    - `titles` string[]
  - `wait_list` object, nullable
    - `default_wait_list_expiry_period` integer

---

[API](https://skmtc.net/cliniko/apis/cliniko-api.md) · [All operations](https://skmtc.net/cliniko/apis/cliniko-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cliniko/cliniko-api/revisions/c129a555ff44/schema)
