---
title: "Get Customer Generic Notes"
method: GET
path: "/v2/customer_portal/notes"
---

# Get Customer Generic Notes

`GET /v2/customer_portal/notes`

## Request

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

## Query parameters

- `module` 'JOB' | 'INVOICE' | 'ESTIMATE' | 'REQUEST' | 'PROPERTY', required
- `module_uid` string, required
- `sort` 'DESC' | 'ASC'
- `sort_by` 'created_at'

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `note_uid` string
    - `note_type` string
    - `attachments` object[]
      - `attachment_name` string
      - `attachment` string
      - `attachment_type` string
      - `attachment_size` integer
      - `_id` string
    - `created_by_type` string
    - `is_private` boolean
    - `visible_to_customer` boolean
    - `is_deleted` boolean
    - `created_at` string
    - `is_v2_note` boolean

## 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/notes/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)