Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the organization settings

This API will be used to fetch the organization settings of a business on Zenoti.

get/v1/organizations/settings/{section}

Path parameters

sectionstring required

This is the section for which the settings are to be retrieved.

Query parameters

expand=work_taskstring

If the expand contains 'work_task', then the response object contains the work task information else the previous response model.

Response

200

OR
OR

Example response

{
  "general": {
    "enable_prepaid_card": true,
    "enable_cross_center_redemptions_for_prepaid_card": true,
    "enable_gift_card": true,
    "enable_memberships": true,
    "enable_packages": true,
    "grid_records": 100,
    "allow_sale_of_onetimeuse_giftcards": true,
    "make_old_guest_form_version_read_only": true,
    "max_file_upload_size": 10485760,
    "org_name": "Hrushikesh"
  },
  "employee": {
    "dashboard": true,
    "multiple_check_ins": true,
    "special_leave_allowed_on": 127,
    "weekend_days": 67,
    "weekly_offs_allowed_per_week": 1,
    "weekly_offs_allowed_on": 127,
    "enable_employee_tip_declaration": true,
    "declared_tips_label": "Declared Tips"
  },
  "memberships": {
    "enable_redemptions_for_open_memberships": true,
    "allow_redemption_for_suspended_memberships": {
      "credit": true,
      "discount": true
    },
    "support_redemption_with_partial_credits": true,
    "enable_credit_redemption_for_products": true
  },
  "feedback_settings": {
    "FeedbackVersion": 2
  },
  "payment": {
    "default_payment_option": "CC",
    "offline_check_mandatory_fields": 7,
    "org_payment_options": [
      {
        "PaymentOptionId": "a2e632a2-7fda-4282-807c-5d0610f3145b",
        "PaymentOptionType": "Check Online",
        "PaymentType": "CHECK",
        "PaymentOptionAssigned": 1,
        "OrgPaymentOptionId": "13782f3f-2645-47dd-ae8e-8404d75a96e7"
      }
    ]
  },
  "appSettings": {
    "signalr_url": "http://devslr.zenoti.com",
    "api_base_address": "http://devapi.zenoti.com",
    "skip_db_call_in_signalr": true,
    "fdo_v2_appt_book_base_url": "https://appt-operations2.zenotibeta.com/"
  },
  "guest": {
    "is_mobile_number_mandatory": true,
    "search_guest_across_centers": true,
    "Send_Marketing_Email_To_NewGuest": true,
    "Send_Marketing_SMS_To_NewGuest": true,
    "Send_Transactional_SMS_To_NewGuest": true,
    "Minor_Age": 18,
    "Check_Minor_Age": true,
    "Send_Marketing_Notifiactions_To_Minors": true,
    "guest_form_type": 1,
    "Allow_Guest_With_Same_Email_Address": true,
    "Enable_Other_Gender": true,
    "whatsapp_optin": 1,
    "private_notes_custom_labels": {
      "private_label": "Private",
      "private_label_2": "Private 2",
      "private_label_3": "Private 3"
    }
  },
  "invoice": {
    "enable_price_adjustment": true,
    "auto_generate_prepaid_number": true,
    "prepaid_number_seed_value": 100,
    "allow_prepaid_cards_with_different_price_and_value": true,
    "allow_gift_cards_with_different_price_and_value": true,
    "allow_changes_to_other_center_invoices": true,
    "auto_generate_giftcard_number": true,
    "enable_multiple_cash_registers": true,
    "Allow_giftcard_amount_to_be_refunded_to_same_card": true,
    "CashBack_Label": "CashBack",
    "Tips_Label": "Tips",
    "SSG_Label": "Support Staff Gratuity",
    "invoice_no_label": "Invoice No",
    "print_item_quantities_on_receipt": true,
    "enable_discount_on_invoice": true,
    "enable_service_sale_during_billing": 1,
    "auto_select_cash_register": true,
    "enable_sms_otp": true,
    "default_otp_mode": 1,
    "membership_sale_to_existing_members": 2,
    "remove_invoice_from_group_on_reopening": true,
    "enable_environmental_fee": true,
    "card_types": [
      {
        "PaymentOptionId": "5dfda2dd-87d9-4f08-9636-67411a0b5a0a",
        "PaymentOptionType": "Amex",
        "PaymentOptionId1": "e605adc4-297b-4067-9691-e46f74e06471",
        "PaymentType": "CC"
      }
    ],
    "change_saleby_from_pos": true,
    "multiple_emp_commission_mask": 31,
    "default_item_type_in_invoice": 2,
    "allow_adjustments_to_discounts": true,
    "show_split_commission_prompt_for": 29,
    "allow_bill_comments": true,
    "block_multiple_invoices": true
  },
  "appointment_book": {
    "alow_booking_voiding_appointments_in_past": true,
    "appointment_booking_during_therapist_non_schedule_hours": 1,
    "Allow_refunds_on_services": true,
    "Search_Guests_across_centers": 1,
    "appointments_time_slots": 15,
    "app_creation_in_non_scheduled_hours": 1,
    "enable_no_show_fee": true,
    "enable_cancellation_fee": true,
    "show_all_therapist": true
  },
  "packages": {
    "enable_package_redemptions_without_payment": true,
    "enable_cross_center_redemption_for_packages": true,
    "edit_package_payment_schedule": 1
  },
  "inventory": {
    "Allow_to_restock_returned_products": true
  },
  "Mobile": {
    "BlockAccessOutsideGeofence": {
      "BlockAccessToEntireApplication": true
    },
    "AllowTrackingConsumables": true
  },
  "CustomData": {
    "Service_CustomData_label": " Service Custom Data",
    "Guest_CustomData_label": "Guest Custom Data",
    "UnifiedView_label": "Forms Unified View",
    "CustomFields_label": "Custom Fields"
  },
  "loyalty_points": {
    "support_enrollment_for_loyaltypoints": true,
    "min_points_for_redemption": 2,
    "max_points_for_redemption": 50,
    "max_redemption_type_in_invoice": true,
    "redeem_services": true,
    "redeem_packages": true,
    "redeem_products": true,
    "redeem_day_packages": true,
    "redeem_gift_cards": true,
    "enable_direct_enrollment_for_tiers": true,
    "loyalty_points_accrual_based_on": 1
  }
}