Skip to main content
GET
/
tenant
/
public
Detail
curl --request GET \
  --url https://api.decodahealth.com/tenant/public \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "name": "<string>",
  "subDomain": "<string>",
  "homePage": "<string>",
  "phoneNumber": "<string>",
  "logoUrl": "<string>",
  "manualInvoiceText": "<string>",
  "passFeeToPatient": true,
  "slogan": "<string>",
  "providerDeactivatedPages": [],
  "patientDeactivatedPages": [],
  "enabledModules": [],
  "hidePatientPaymentPlans": false,
  "requiredPatientFields": [],
  "selfSchedulingRedirectUrl": "<string>",
  "allowMultipleBookingsForDifferentAppointments": false,
  "allowMultipleSelfScheduleAppointments": false,
  "receiptLogoUrl": "<string>",
  "receiptGradientColor": "<string>",
  "googleTagManagerId": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Response

200 - application/json

Successful Response

A publically exposable Tenant

name
string
required
subDomain
string
required
homePage
string
required
phoneNumber
string
required
logoUrl
string
required
manualInvoiceText
string
required
passFeeToPatient
boolean
required
slogan
string | null
providerDeactivatedPages
string[]
patientDeactivatedPages
string[]
enabledModules
enum<string>[]
Available options:
TEXTING,
CALLING,
PAYMENTS,
SCRIBE,
SCHEDULING,
FORMS,
INVENTORY,
LOCATIONS,
CALENDAR_PATIENT_STATUS,
SPAKINECT,
SCRIBE_MEDICAL_CODES
hidePatientPaymentPlans
boolean
default:false
requiredPatientFields
string[]
selfSchedulingRedirectUrl
string | null
allowMultipleBookingsForDifferentAppointments
boolean
default:false
allowMultipleSelfScheduleAppointments
boolean
default:false
receiptLogoUrl
string | null
receiptGradientColor
string | null
googleTagManagerId
string | null