---
title: "List notes"
method: GET
path: "/notes"
tags: ["Note"]
---

# List notes

`GET /notes`

## Request

- Base URL: `https://api.paidnice.com/rest/v1`
- URL: `https://api.paidnice.com/rest/v1/notes`
- Auth: HTTP bearer

Returns notes written on a contact or an invoice, newest first. Pass exactly one of contactId or invoiceId. Notes on a contact include the notes on each of its invoices.

## Query parameters

- `limit` integer: Maximum number of records to return
- `cursor` string: Opaque cursor from a previous response's nextCursor. Omit to start from the most recent record.
- `contactId` integer, nullable: Notes on this contact, including notes on its invoices
- `invoiceId` string, uuid: Notes on this invoice

## Response `200`

A page of notes

- object
  - `data` Note[], required
    - `id` integer, required
    - `createdAt` string, required
    - `content` string, required
    - `authorName` string, nullable, required
    - `contactId` integer, required
    - `invoiceId` string, nullable, required
  - `nextCursor` string: Pass as the cursor query parameter to fetch the next page. Absent on the last page.

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key
- `403`: The public API is not enabled for the organisation, or the API key lacks the required scope
- `429`: Too many requests

---

[API](https://skmtc.dev/paidnice/apis/paidnice-public-api.md) · [All operations](https://skmtc.dev/paidnice/apis/paidnice-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paidnice/apis/paidnice-public-api/revisions/d4911087b8e7?raw)