CLclinicos
ClinicSettings

Get clinic settings from DynamoDB profile data

Changed on
get/clinic-settings

Request

Response

OK

companyIdstring
companyNamestring
clinicAddressstring nullable
clinicPhonestring nullable
clinicEmailstring nullable
clinicFaxstring nullable

Clinic fax number. Printed on written prescriptions (ITE-1233); blank is fine.

clinicAboutNotesstring nullable
schedulingPolicystring
timezonestring

The clinic's IANA zone. Never null — server-side formatters (email, SMS, voice, PDFs, labels) have no sane way to degrade and must not fall through to UTC, so an unconfigured tenant reads back as Eastern. Check bool ClinicSettingsDto.TimezoneConfigured before trusting it as the clinic's actual location.

timezoneConfiguredboolean

False when the tenant has no stored timezone and string ClinicSettingsDto.Timezone is therefore the Eastern placeholder rather than a real setting. The web app uses this to prefer the workstation's own zone: rendering a Pacific clinic's day in Eastern is what produced ITE-337.

billingStatusstring nullable

Billing/contract state: "Trial", "Active", "Suspended", or empty for legacy records (treated as "Active"). Drives GDPR consent banner visibility post-login.

widgetAllowedDomainsstring[]

Origins allowed to iframe this clinic's booking widget (/embed/{clinicId}), e.g. https://www.example.com or https://*.example.com. The widget's middleware turns these into its CSP frame-ancestors; the ClinicOS domains are always allowed on top. Stored as widgetAllowedDomains on the company record.

Changes

  • f7ab358172d0Revision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property ///// to the response with the status (media type: text/plain)

    • info

      added the optional property ///// to the response with the status (media type: application/json)

    • info

      added the optional property ///// to the response with the status (media type: text/json)

  • 021fabd866ffRevision changes
    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)