Get Customer Portal Config

Changed on
get/customer_portal/config/

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/customer_portal/config/
  • Auth
    API key in header x-api-key

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "customer_portal_config_uid": "06115720-acf8-11ed-bc57-a5d29c53f803",
    "payments": {
      "allow_card_on_file": true
    },
    "estimate": {
      "get_customer_sign_on_approval": true,
      "enforce_deposit_for_accept": true
    },
    "portal_logo": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/3c0f3c2b-49de-44b1-95b5-57b44463df95/9fae14bb-e7d3-4afa-bd23-cb3e4ea7837d.png",
    "appearance": {
      "primary_color": "#140f0f",
      "secondary_color": "#ffffff",
      "font_family": "Roboto",
      "footer": "test",
      "navbar": [
        {
          "label": "Dashboard",
          "redirect_type": "PAGE",
          "redirect_to": "DASHBOARD",
          "is_visible": true,
          "_id": "6846d78d124b1ca38340718a"
        }
      ]
    },
    "created_at": "2023-02-15T06:14:37.205Z",
    "updated_at": "2025-06-09T12:46:05.948Z",
    "portal_name": "Zuper Pays",
    "portal_favicon": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/3c0f3c2b-49de-44b1-95b5-57b44463df95/de012345-53aa-4f3b-a50c-547dcccfab0f.png",
    "authentication_type": "OTP_OR_PASSWORD",
    "portal_contact": "test123@gmail.com",
    "notification": {
      "notify_scope": "SELECTED_USERS",
      "selected_users": [
        {
          "user_uid": "f2f5bb37-cd1b-4864-92d7-1e59c493f0bd",
          "first_name": "Katrina",
          "last_name": "Whale",
          "email": "kat@gmail.com",
          "home_phone_number": "0988753484",
          "designation": "Field Executive",
          "emp_code": "1029",
          "work_phone_number": "0988753484",
          "profile_picture": "https://i.imgur.com/phnZHKE.png",
          "hourly_labor_charge": 20,
          "is_active": 1,
          "created_at": "2018-06-11T17:07:23.000Z",
          "updated_at": "2025-03-19T10:05:58.000Z"
        }
      ]
    }
  }
}

Changes