get
https://api.zenoti.com/v1/organizations/settings/
This API will be used to fetch the organization settings of a business on Zenoti.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Model
BookingWizardSettingViewModel
| Json property | Data type | Description |
|---|---|---|
| holdtime | int | Appointment hold time |
| overlap | int | Allow appointment overlap |
| interval | int | Appointment interval FK |
TrainingSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| fitness_kiosk_enabled | bool | Enable Fitness Kiosk |
PrimaryWorkTask
| Json property | Data type | Description |
|---|---|---|
| is_primary_work_task_enabled | bool? | Enable primary work task |
| id | Guid? | Primary work task ID |
ZenotiMobileSettingViewModel
| Json property | Data type | Description |
|---|---|---|
| BlockAccessOutsideGeofence | GeofenceSetting | Geofence restriction setting |
| PayPeriodBasedReporting | bool | Enable pay period based reporting |
| AllowTrackingConsumables | bool | Enable consumables tracking |
| disable_employee_checkin_outside_geofence | bool | Disable employee check-in outside geofence |
| allow_capturing_employee_signature_in_mobile | bool | Allow employee signature capture in mobile |
GeofenceSetting
| Json property | Data type | Description |
|---|---|---|
| BlockAccessToEntireApplication | bool | Block full application access |
| BlockAccessToGuestData | bool | Block access to guest data |
CustomDataLabelsViewModel
| Json property | Data type | Description |
|---|---|---|
| Service_CustomData_label | string | Label for service custom data |
| Guest_CustomData_label | string | Label for guest custom data |
| UnifiedView_label | string | Unified form label |
| CustomFields_label | string | Custom fields label |
| restrict_form | RestrictFormEnum | Restriction setting for form usage |
GeneralSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| lock_date | DateTime? | Lock date |
| lock_days | int? | Number of lock days |
| account_name | string | Organization account name |
| enforce_inactvity_login | bool | Enforce inactivity login |
| creditcard_entry_for_appointment | CreditCardOnFileSetting | Credit card entry setting |
| enable_connect | bool | Enable Zenoti Connect |
| include_tip_and_ssg_in_actual_amt | bool | Include tips and SSG in actual amount |
| enable_prepaid_card | bool | Enable prepaid cards |
| enable_cross_center_redemptions_for_prepaid_card | bool | Allow cross-center redemptions for prepaid cards |
| enable_gift_card | bool | Enable gift cards |
| Enable_TaxInclusive_Pricing | bool | Enable tax-inclusive pricing |
| GiftCardSale_TaxInclusive | bool | Tax-inclusive gift card sales |
| Enable_Mobile_Pos_In_Android | bool | Enable POS in Android |
| enable_memberships | bool | Enable memberships |
| enable_packages | bool | Enable packages |
| Enable_Self_Checkin | bool | Enable self check-in |
| Guest_Kiosk_Enabled | bool | Enable guest kiosk |
| Support_For_Saved_Cards_During_Migration | bool | Support saved card migration |
| enable_self_pay | bool | Enable self-pay |
| enable_auto_pay | bool | Enable auto-pay |
| restrict_zenotiGo_for_members | bool | Restrict auto-pay to members |
| auto_pay_terms_and_conditions | string | Terms for auto-pay |
| self_checkin_descriptions | string | Self check-in description |
| self_pay_descriptions | string | Self pay description |
| aws_s3_config | AwsS3Config | AWS S3 configuration |
| enable_tcpa_for_promotional_messages | bool | Enable TCPA messaging compliance |
| grid_records | int | Grid record count |
| enable_classes | bool | Enable classes |
| sms_appointment_remainder_template | bool | SMS reminder template enabled |
| email_appointment_remainder_template | bool | Email reminder template enabled |
| referral_marketing_referral_id | Guid? | Referral marketing ID |
| disable_pre_authorization | bool | Disable CC pre-authorization |
| allow_sale_of_onetimeuse_giftcards | bool | Allow one-time use gift card sales |
| make_old_guest_form_version_read_only | bool | Read-only old guest forms |
| max_file_upload_size | int | Max upload file size |
| org_name | string | Organization name |
AwsS3Config
| Json property | Data type | Description |
|---|---|---|
| bucket_name | string | S3 bucket name |
| access_key | string | AWS access key |
| secret_Key | string | AWS secret key |
| uploading_enabled | bool | Is uploading enabled |
EmployeeSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| dashboard | bool | Enable dashboard |
| multiple_check_ins | bool | Allow multiple check-ins |
| multiple_deputations | bool | Allow multiple deputations |
| biometric | bool | Enable biometric check-in |
| enforce_passcode | bool | Enforce passcode |
| mobile_checkin | bool | Mobile check-in enabled |
| special_leave_allowed_on | int | Special leave on specific days |
| weekend_days | int | Weekend days |
| weekly_offs_allowed_per_week | int | Allowed weekly offs |
| weekly_offs_allowed_on | int | Weekly offs on specific days |
| Enable_emp_sales_drill_down | bool | Sales drill-down enabled |
| bypass_authentication_for_employee_checkin | bool | Bypass check-in authentication |
| allow_invoice_item_commission_adjustment | bool | Allow invoice commission adjustment |
| enable_employee_tip_declaration | bool | Enable tip declaration |
| restrict_time_entry_to_logedin_user | bool | Restrict time entry |
| declared_tips_label | string | Declared tips label |
| primary_work_task | PrimaryWorkTask | Nested task settings |
MembershipsSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| enable_redemptions_for_open_memberships | bool | Enable redemptions on open memberships |
| allow_membership_redemption_while_booking | bool | Allow redemption while booking |
| redeem_membership_service_credits_post_expiry | MembershipServiceCreditRedemtionPostExpiryEnum | Redemption after expiry |
| allow_redemption_for_suspended_memberships | RedemptionForSuspendedMemberships | Redemption rules for suspended memberships |
| default_freeze_type | MembershipBenefitsFreezeType | Default freeze type |
| support_redemption_with_partial_credits | bool | Allow redemption with partial credits |
| enable_credit_redemption_for_products | bool | Redeem credits for products |
| enable_hybrid_model_for_membership_credits | bool | Enable hybrid membership credits |
FeedbackSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| FeedbackVersion | int | Version of feedback used |
RedemptionForSuspendedMemberships
| Json property | Data type | Description |
|---|---|---|
| credit | bool | Allow credit redemption |
| discount | bool | Allow discount redemption |
PaymentSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| default_payment_option | string | Default payment option |
| offline_check_mandatory_fields | int | Bitmask for required check fields |
| org_payment_options | List | Available payment options |
OrgPaymentOptionsModel
| Json property | Data type | Description |
|---|---|---|
| PaymentOptionId | string | Unique payment option ID |
| PaymentOptionType | string | Type of payment option |
| PaymentType | string | Payment method type |
| PaymentOptionAssigned | int | Whether assigned |
| TypeOfPayment | int | Type of payment |
| OrgPaymentOptionId | string | Org-specific ID |
| PaymentOptionType2 | string | Alternate type |
| CustomPaymentName | string | Custom name |
AppSettingsViewModel
| Json property | Data type | Description |
|---|---|---|
| signalr_url | string | SignalR URL |
| log_signalr | bool? | Log SignalR messages |
| api_base_address | string | API base URL |
| signalr_enabled | bool? | Enable SignalR |
| mms_signalr_enabled | bool? | Enable MMS SignalR |
| mms_signalr_enabled_for_all_orgs | bool? | Enable MMS SignalR for all orgs |
| skip_db_call_in_signalr | bool? | Skip DB call |
| fdo_v2_appt_book_base_url | string | URL for FDO v2 appointment book |
Enums
RestrictFormEnum
| Enum Name | Value | Description |
|---|---|---|
| None | 0 | No restriction |
| AdminOnly | 1 | Only admin can access |
| AllUsers | 2 | Available to all users |