---
title: "Get Customer Portal Config"
method: GET
path: "/customer_portal/config"
---

# Get Customer Portal Config

`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`

200

- object
  - `type` string
  - `data` object
    - `customer_portal_config_uid` string
    - `company_id` string
    - `jobs` object
      - `allow_reshedule` boolean
      - `reschedule_before_days` integer
      - `reschedule_after_days` integer
    - `payments` object
      - `allow_card_on_file` boolean
      - `download_receipt` boolean
    - `estimate` object
      - `allow_request_for_change` boolean
      - `get_customer_sign_on_approval` boolean
      - `allow_line_item_comments` boolean
      - `allow_attachments` boolean
      - `enforce_deposit_for_accept` boolean
    - `portal_logo` string
    - `appearance` object
      - `primary_color` string
      - `secondary_color` string
      - `font_family` string
      - `custom_css` string
      - `custom_js` string
      - `footer` string
      - `navbar` object[]
        - `label` string
        - `redirect_type` string
        - `redirect_to` string
        - `is_visible` boolean
        - `fields` object
          - `listing` unknown[]
            - unknown
          - `details` unknown[]
            - unknown
        - `_id` string
    - `created_at` string
    - `updated_at` string
    - `portal_name` string
    - `portal_favicon` string
    - `authentication_type` string

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/customer_portal/config/get~2.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)