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

# List notes

`GET /notes`

## Request

- Base URL: `https://api.parley.so/v1`
- URL: `https://api.parley.so/v1/notes`
- Auth: HTTP bearer

List the notes on one project, account, or contact, newest first by default: pass exactly one of projectId, accountId, or contactId. Rows leave out the content; get a note by ID to read it. Returns 400 INVALID_REFERENCE when the record doesn't exist or you can't see it.

## Query parameters

- `projectId` string: Only the notes on this project. Pass exactly one of projectId, accountId, or contactId.
- `accountId` string: Only the notes on this account. Pass exactly one of projectId, accountId, or contactId.
- `contactId` string: Only the notes on this contact. Pass exactly one of projectId, accountId, or contactId.
- `search` string: Case-insensitive. Only notes whose title contains this text.
- `createdSince` string: Only records created at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `createdBefore` string: Only records created before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedSince` string: Only records last updated at or after this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `updatedBefore` string: Only records last updated before this time. An ISO 8601 date (YYYY-MM-DD, read as UTC midnight) or date-time.
- `sort` 'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt': Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.
- `cursor` string: Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.
- `limit` integer: Maximum number of items to return.

## Response `200`

OK

- object
  - `data` Note[], required
    - `id` string, required: The note ID.
    - `name` string, required: The note title.
    - `location` object, required: The project, account, or contact the note is on.
      - `type` 'project' | 'account' | 'contact', required: The kind of record: project, account, or contact.
      - `id` string, required: Its ID.
      - `name` string, required: The record's name. A contact's is its first and last name, or an email address when it has no name.
    - `version` integer, required: Goes up by one each time the content changes or the note is renamed through the API. Pass it as expectedVersion when updating the note.
    - `createdAt` string, date-time, required: When the note was created.
    - `updatedAt` string, date-time, required: When the note was last changed, including renames.
  - `nextCursor` string, nullable, required: Cursor for the next page, or null on the last page.

## Other responses

- `400`: The request was invalid. VALIDATION_FAILED, INVALID_CURSOR, INVALID_REFERENCE.
- `401`: Missing or invalid credentials. UNAUTHORIZED.
- `403`: You don't have permission. FORBIDDEN.
- `429`: Too many requests, or a usage limit was reached. TOO_MANY_REQUESTS.

---

[API](https://skmtc.dev/parley/apis/parley-api.md) - [All operations](https://skmtc.dev/parley/apis/parley-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parley/apis/parley-api/revisions/6b78aeee07bc?raw)