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

# GET /notes

`GET /notes`

Schema for Notes

## Query parameters

- `pageSize` integer
- `sortOrder` union
  - 'asc'
  - 'desc'
- `pageCursor` string
- `sortField` 'created_at'
- `filterEntityId` number
- `filterEntityName` 'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE', required
- `filterCreatedById` number

## Response `200`

Successful Response

- GetNotesResponse
  - `result` string, required
  - `data` Note[], required
    - `id` number, required
    - `companyId` number, required
    - `entityId` number, required
    - `entityName` 'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE', required
    - `text` string, required
    - `createdById` number, required
    - `createdAt` string, required
    - `isPinned` boolean, required
    - `parentId` number, nullable, required
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
    - `replies` NoteReply[]
      - `id` number, required
      - `companyId` number, required
      - `entityId` number, required
      - `entityName` 'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE', required
      - `text` string, required
      - `createdById` number, required
      - `createdAt` string, required
      - `isPinned` boolean, required
      - `parentId` number, nullable, required
      - `links` Links[], required
        - `href` string, required
        - `rel` string, required
        - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required
  - `paging` Pagination
    - `perPage` number, required
    - `pageCount` number, required
    - `links` object, required
      - `self` string, required
      - `previous` string, nullable, required
      - `next` string, nullable, required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/b4f232a22363/schema)