---
title: "Get Portals"
method: GET
path: "/customer_portal"
---

# Get Portals

`GET /customer_portal`

## Request

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

## Query parameters

- `page` integer, required
- `count` integer, required
- `sort` 'DESC' | 'ASC'
- `sort_by` 'created_at' | 'portal_name'
- `filter.keyword` string
- `filter.is_active` boolean
- `filter.is_deleted` boolean
- `filter.module` 'JOB' | 'CUSTOMER' | 'ESTIMATE' | 'INVOICE' | 'SERVICE_CONTRACT' | 'ASSET' | 'REQUEST'
- `filter.updated_at_from` string, date
- `filter.updated_at_to` string, date

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `portal_uid` string
    - `portal_name` string
    - `module` string
    - `page` string
    - `is_active` boolean
    - `is_deleted` boolean
    - `created_by` object
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `external_login_id` unknown
      - `home_phone_number` string
      - `designation` string
      - `emp_code` string
      - `prefix` unknown
      - `work_phone_number` string
      - `mobile_phone_number` unknown
      - `profile_picture` string
      - `hourly_labor_charge` integer
      - `is_active` boolean
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
    - `created_at` string
    - `updated_at` string
    - `id` string
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## 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/get.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)