---
title: "Get Property"
method: GET
path: "/v2/customer_portal/property"
---

# Get Property

`GET /v2/customer_portal/property`

## Request

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

## Query parameters

- `page` integer, required
- `count` integer, required
- `sort` 'DESC' | 'ASC'
- `created_at` 'created_at' | 'property_name'
- `filter.keyword` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `updated_at` string
    - `created_at` string
    - `is_active` boolean
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `hide_to_fe` boolean
      - `_id` string
    - `property_address` object
      - `city` string
      - `state` string
      - `street` string
      - `country` string
      - `zip_code` string
      - `_id` string
    - `property_organization` object
      - `is_deleted` boolean
      - `organization_address` object
        - `city` string
        - `state` string
        - `street` string
        - `landmark` string
        - `zip_code` string
        - `geo_cordinates` number[]
        - `first_name` string
        - `last_name` string
        - `phone_number` string
        - `email` string
        - `point_coordinates` object
          - `type` string
          - `coordinates` number[]
      - `organization_name` string
      - `organization_logo` string
      - `organization_email` string
      - `organization_description` unknown
      - `organization_uid` string
      - `no_of_customers` integer
    - `no_of_jobs` integer
    - `property_customers` object[]
      - `customer` object
        - `customer_last_name` string
        - `customer_billing_address` object
          - `city` string
          - `state` string
          - `street` string
          - `zip_code` string
          - `first_name` string
          - `last_name` string
          - `phone_number` string
          - `email` string
          - `geo_cordinates` number[]
          - `point_coordinates` object
            - `type` string
            - `coordinates` number[]
        - `customer_address` object
          - `city` string
          - `state` string
          - `street` string
          - `zip_code` string
          - `first_name` string
          - `last_name` string
          - `phone_number` string
          - `email` string
          - `geo_cordinates` number[]
          - `point_coordinates` object
            - `type` string
            - `coordinates` number[]
        - `customer_first_name` string
        - `customer_uid` string
    - `property_name` string
    - `property_uid` string
  - `current_page_records` integer
  - `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/v2/customer_portal/property/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)