Skip to main content
GET
/
tenant
/
private
Private Detail
curl --request GET \
  --url https://api.decodahealth.com/tenant/private \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "name": "<string>",
  "subDomain": "<string>",
  "providerDeactivatedPages": [
    "<string>"
  ],
  "patientDeactivatedPages": [
    "<string>"
  ],
  "enabledModules": [
    "TEXTING"
  ],
  "homePage": "<string>",
  "passFeeToPatient": true,
  "paymentProcessor": "<string>",
  "activatedChargeMethods": [
    "<string>"
  ],
  "phoneNumber": "<string>",
  "logoUrl": "<string>",
  "successfulPaymentText": "<string>",
  "campaign": "<string>",
  "enterpriseTenant": "<string>",
  "manualInvoiceText": "<string>",
  "sendReceiptText": "<string>",
  "smsProvider": "SIGNALWIRE",
  "clinicType": "DEFAULT",
  "practiceTypeCode": 123,
  "slogan": "<string>",
  "replyToEmail": "<string>",
  "ccEmail": "<string>",
  "defaultTimezone": "<string>",
  "hidePatientPaymentPlans": false,
  "coloredMail": false,
  "requiredPatientFields": [],
  "enabledCommunicationMethods": [],
  "enabledInvoiceMethods": [
    "EMAIL",
    "SMS",
    "CHARGE_CARD"
  ],
  "maxInvoicesPerDay": 100,
  "invoicingStartTime": 9,
  "invoicingEndTime": 17,
  "invoicingOnWeekends": false,
  "invoicingExcludesHolidays": false,
  "maxInvoicesPerMinute": 10,
  "autoRespondToSms": false,
  "generateResponseOnSms": false,
  "billAutomatically": false,
  "selfSchedulingRedirectUrl": "<string>",
  "allowMultipleBookingsForDifferentAppointments": false,
  "daysUntilPatientBecomesNew": 123,
  "maxSelfScheduleServices": 1,
  "mailDomain": "<string>",
  "mailReceivingEnabled": false,
  "mailgunDomain": {
    "id": "<string>",
    "domainName": "<string>",
    "state": "UNVERIFIED",
    "isSendingVerified": true,
    "isReceivingVerified": true,
    "createdDate": "2023-11-07T05:31:56Z",
    "smtpLogin": "<string>",
    "dnsRecords": {},
    "updatedDate": "2023-11-07T05:31:56Z",
    "verifiedDate": "2023-11-07T05:31:56Z"
  },
  "createCreditFromBookingFee": false,
  "serviceDisplayMode": "GRID",
  "authTimeoutMs": 123,
  "ipBlockingEnabled": false,
  "introductoryText": "<string>",
  "optOutMessage": "<string>",
  "helpMessage": "<string>",
  "apiKey": "<string>",
  "gcalEmail": "<string>",
  "gcalToken": "<string>",
  "gcalRefreshToken": "<string>",
  "markChatReadOnAiResponse": false,
  "auditSmsResponse": false,
  "itemSortType": "USAGE",
  "reservationCancellationSmsTemplate": "<string>",
  "quoteSmsText": "<string>",
  "automaticallySendReceipts": true,
  "defaultReceiptCommunicationMethod": "SMS",
  "receiptLogoUrl": "<string>",
  "receiptGradientColor": "<string>",
  "duplicatePatientFields": [
    "first_name",
    "last_name",
    "phone_number"
  ],
  "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

The configuration for each of the clients of Decoda.

​
name
string
required
​
subDomain
string
required
​
providerDeactivatedPages
string[]
required
​
patientDeactivatedPages
string[]
required
​
enabledModules
enum<string>[]
required
Available options:
TEXTING,
CALLING,
PAYMENTS,
SCRIBE,
SCHEDULING,
FORMS,
INVENTORY,
LOCATIONS,
CALENDAR_PATIENT_STATUS,
SPAKINECT,
SCRIBE_MEDICAL_CODES,
DOSESPOT,
CLOCK_IN,
EMAILS,
GOOGLE_RWG
​
homePage
string
required
​
passFeeToPatient
boolean
required
​
paymentProcessor
string
required
​
activatedChargeMethods
string[]
required
​
phoneNumber
string
required
​
logoUrl
string
required
​
successfulPaymentText
string
required
​
campaign
string
required
​
enterpriseTenant
string | null
required
​
manualInvoiceText
string
required
​
sendReceiptText
string
required
​
smsProvider
enum<string>
required
Available options:
SIGNALWIRE,
SENDO
​
clinicType
enum<string>
default:DEFAULT
Available options:
DEFAULT,
WEIGHT_LOSS,
MED_SPA
​
practiceTypeCode
integer | null
​
slogan
string | null
​
replyToEmail
string | null
​
ccEmail
string | null
​
defaultTimezone
string | null
​
hidePatientPaymentPlans
boolean
default:false
​
coloredMail
boolean
default:false
​
requiredPatientFields
string[]
​
enabledCommunicationMethods
enum<string>[]
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
enabledInvoiceMethods
enum<string>[]

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY
​
maxInvoicesPerDay
integer
default:100
​
invoicingStartTime
integer
default:9
​
invoicingEndTime
integer
default:17
​
invoicingOnWeekends
boolean
default:false
​
invoicingExcludesHolidays
boolean
default:false
​
maxInvoicesPerMinute
integer
default:10
​
autoRespondToSms
boolean
default:false
​
generateResponseOnSms
boolean
default:false
​
billAutomatically
boolean
default:false
​
selfSchedulingRedirectUrl
string | null
​
allowMultipleBookingsForDifferentAppointments
boolean
default:false
​
daysUntilPatientBecomesNew
integer | null
​
maxSelfScheduleServices
integer
default:1
​
mailDomain
string | null
​
mailReceivingEnabled
boolean
default:false
​
mailgunDomain
MailgunDomain · object

Mailgun domain object loaded with tenant.

​
createCreditFromBookingFee
boolean
default:false
​
serviceDisplayMode
enum<string>
default:GRID

Display mode for services in self-scheduling.

Available options:
GRID,
MENU
​
authTimeoutMs
integer | null
​
ipBlockingEnabled
boolean
default:false
​
introductoryText
string | null
​
optOutMessage
string | null
​
helpMessage
string | null
​
apiKey
string | null
​
gcalEmail
string | null
​
gcalToken
string | null
​
gcalRefreshToken
string | null
​
markChatReadOnAiResponse
boolean
default:false
​
auditSmsResponse
boolean
default:false
​
itemSortType
enum<string>
default:USAGE
Available options:
CATEGORY,
USAGE,
DEFINED_ORDER,
NAME,
PRICE
​
reservationCancellationSmsTemplate
string | null
​
quoteSmsText
string | null
​
automaticallySendReceipts
boolean
default:true
​
defaultReceiptCommunicationMethod
enum<string>
default:SMS
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
receiptLogoUrl
string | null
​
receiptGradientColor
string | null
​
duplicatePatientFields
string[]
​
googleTagManagerId
string | null