Settings

Settings

object or null
object or null
object or null
object or null
Deprecated
object or null
object or null
object or null
object or null
object or null
object or null
object or null
object or null
object or null
{
  • "account": {
    • "id": "1",
    • "name": "string",
    • "country": "string",
    • "country_code": "AU",
    • "currency_symbol": "string",
    • "subdomain": "string",
    • "has_time_travelers": true,
    • "time_zone_support": true,
    • "email_from": "string",
    • "first_name": "string",
    • "last_name": "string",
    • "compliance": {
      • "has_hipaa_compliance_conflicts": true,
      • "hipaa_compliance-conflict_messages": [
        ]
      }
    },
  • "calendar": {
    • "start_hour": 0,
    • "end_hour": 0,
    • "timeslot_height_in_pixels": 0,
    • "timeslot_size_in_minutes": 0,
    • "show_current_time_indicator": true,
    • "multiple_appointments_gap": true
    },
  • "documents_and_printing": {},
  • "email": {
    • "patient_accept_email_marketing_by_default": true
    },
  • "integrations": {
    • "mail_chimp": {
      • "enabled": true
      },
    • "xero": {
      • "enabled": true
      },
    • "medipass": {
      • "enabled": true
      }
    },
  • "online_bookings": {
    • "allow_bookings_days_in_advance": 0,
    • "allow_online_bookings_time_zone_choice": true,
    • "booking_reservation_minutes": 0,
    • "calendar_info": "string",
    • "daily_bookings_limit": 0,
    • "disabled_text": "string",
    • "disabled_title": "string",
    • "enabled": true,
    • "logo_url": "http://example.com",
    • "max_appointments_per_day_segment": 0,
    • "min_hours_advance_required_to_book": 0,
    • "min_hours_notice_for_patient_cancellation": 0,
    • "notice_enabled": true,
    • "notice_text": "string",
    • "notice_title": "string",
    • "notify_practitioner_by_email": true,
    • "notify_practitioner_by_sms": true,
    • "policy": "string",
    • "practitioner_order": [
      • "string"
      ],
    • "privacy_policy_url": "http://example.com",
    • "require_patient_address": true,
    • "show_appointment_duration": true,
    • "show_prices": true,
    • "adroll": {
      • "advertiser_id": "string",
      • "pixel_id": "string"
      },
    • "google_analytics": {
      • "tracking_id": "string"
      },
    • "google_tag_manager": {
      • "container_id": "string"
      }
    },
  • "online_payments": {
    • "activated": true
    },
  • "patient_custom_fields_definition": {
    • "sections": [
      • {
        }
      ]
    },
  • "patient_privacy": {
    • "browser_title_name_format": "first_name",
    • "ical_patient_name_option": "first_name",
    • "prevent_sending_financial_data_by_email": true,
    • "requires_hipaa_compliance": true,
    • "anonymise_appointments_on_deletion": true,
    • "anonymise_booking_notifications": true,
    • "anonymise_invoices_and_payments_on_deletion": true,
    • "baa_requested": true
    },
  • "reminders": {
    • "default_reminder_type": "None"
    },
  • "sms": {
    • "alphanumeric_source_number_required": true,
    • "default_alphanumeric_source_number": "string",
    • "max_message_length": 0,
    • "number_of_usable_characters_per_message": 0,
    • "patient_accept_sms_marketing_by_default": true,
    • "replies_supported": true
    },
  • "terminology": {
    • "patient": "patient",
    • "titles": [
      • "string"
      ]
    },
  • "wait_list": {
    • "default_wait_list_expiry_period": 0
    }
}

Get settings

get/settings

This endpoint is only accessible to users with a role that can view settings.

SecuritybasicAuth
Responses
200

Successful operation

Request samples 
Response samples 
application/json
{
  • "account": {
    • "id": "1",
    • "name": "string",
    • "country": "string",
    • "country_code": "AU",
    • "currency_symbol": "string",
    • "subdomain": "string",
    • "has_time_travelers": true,
    • "time_zone_support": true,
    • "email_from": "string",
    • "first_name": "string",
    • "last_name": "string",
    • "compliance": {
      • "has_hipaa_compliance_conflicts": true,
      • "hipaa_compliance-conflict_messages": [
        ]
      }
    },
  • "calendar": {
    • "start_hour": 0,
    • "end_hour": 0,
    • "timeslot_height_in_pixels": 0,
    • "timeslot_size_in_minutes": 0,
    • "show_current_time_indicator": true,
    • "multiple_appointments_gap": true
    },
  • "documents_and_printing": {},
  • "email": {
    • "patient_accept_email_marketing_by_default": true
    },
  • "integrations": {
    • "mail_chimp": {
      • "enabled": true
      },
    • "xero": {
      • "enabled": true
      },
    • "medipass": {
      • "enabled": true
      }
    },
  • "online_bookings": {
    • "allow_bookings_days_in_advance": 0,
    • "allow_online_bookings_time_zone_choice": true,
    • "booking_reservation_minutes": 0,
    • "calendar_info": "string",
    • "daily_bookings_limit": 0,
    • "disabled_text": "string",
    • "disabled_title": "string",
    • "enabled": true,
    • "logo_url": "http://example.com",
    • "max_appointments_per_day_segment": 0,
    • "min_hours_advance_required_to_book": 0,
    • "min_hours_notice_for_patient_cancellation": 0,
    • "notice_enabled": true,
    • "notice_text": "string",
    • "notice_title": "string",
    • "notify_practitioner_by_email": true,
    • "notify_practitioner_by_sms": true,
    • "policy": "string",
    • "practitioner_order": [
      • "string"
      ],
    • "privacy_policy_url": "http://example.com",
    • "require_patient_address": true,
    • "show_appointment_duration": true,
    • "show_prices": true,
    • "adroll": {
      • "advertiser_id": "string",
      • "pixel_id": "string"
      },
    • "google_analytics": {
      • "tracking_id": "string"
      },
    • "google_tag_manager": {
      • "container_id": "string"
      }
    },
  • "online_payments": {
    • "activated": true
    },
  • "patient_custom_fields_definition": {
    • "sections": [
      • {
        }
      ]
    },
  • "patient_privacy": {
    • "browser_title_name_format": "first_name",
    • "ical_patient_name_option": "first_name",
    • "prevent_sending_financial_data_by_email": true,
    • "requires_hipaa_compliance": true,
    • "anonymise_appointments_on_deletion": true,
    • "anonymise_booking_notifications": true,
    • "anonymise_invoices_and_payments_on_deletion": true,
    • "baa_requested": true
    },
  • "reminders": {
    • "default_reminder_type": "None"
    },
  • "sms": {
    • "alphanumeric_source_number_required": true,
    • "default_alphanumeric_source_number": "string",
    • "max_message_length": 0,
    • "number_of_usable_characters_per_message": 0,
    • "patient_accept_sms_marketing_by_default": true,
    • "replies_supported": true
    },
  • "terminology": {
    • "patient": "patient",
    • "titles": [
      • "string"
      ]
    },
  • "wait_list": {
    • "default_wait_list_expiry_period": 0
    }
}