/notes

GET /notes

Get notes for a specific object

Retrieves notes associated with a specific table and row ID

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

tableName query string

The name of the table the notes are related to (valid values are 'leads', 'merchants', 'applications')

rowId query string

The ID of the row in the table the notes are related to

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

Page number for pagination

pageSize query integer

Number of items per page

Try it out

Output:

Responses

Description

A list of notes

{
  "notes": [
    {
      "id": 0,
      "content": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "tableName": "string",
      "rowId": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0,
  "currentPage": 0
}

References

#/components/schemas/Note #/components/schemas/NoteList

type: object
properties:
  id:
    type: integer
    readOnly: true
  content:
    type: string
    description: The content of the note
  createdAt:
    type: string
    format: date-time
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    readOnly: true
  createdBy:
    type: string
    readOnly: true
    description: Email of the user who created the note
  updatedBy:
    type: string
    readOnly: true
    description: Email of the user who last updated the note
  tableName:
    type: string
    description: The name of the table the note is related to
    enum:
      - leads
      - merchants
      - applications
  rowId:
    type: string
    description: The ID of the row in the table the note is related to
required:
  - content
  - tableName
  - rowId

|
export interface Note {
  id?: number;
  /** The content of the note */
  content: string;
  createdAt?: Date;
  updatedAt?: Date;
  /** Email of the user who created the note */
  createdBy?: string;
  /** Email of the user who last updated the note */
  updatedBy?: string;
  /** The name of the table the note is related to */
  tableName: "leads" | "merchants" | "applications";
  /** The ID of the row in the table the note is related to */
  rowId: string;
}

#/components/schemas/NoteList

OpenAPI
TypeScript

type: object
properties:
  notes:
    type: array
    items:
      $ref: "#/components/schemas/Note"
  totalCount:
    type: integer
  totalPages:
    type: integer
  currentPage:
    type: integer

|
export interface NoteList {
  notes?: Note[];
  totalCount?: number;
  totalPages?: number;
  currentPage?: number;
}

Route Source Code

Check out the source code for this route entrypoint here: /notes/route.ts

Or the swagger.yaml spec this documentation was generated from: /notes/swagger.yaml