> ## Documentation Index
> Fetch the complete documentation index at: https://docs.leadstaker.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List notes

> Answers with a bare array of notes, without an envelope or pagination fields.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/notes
openapi: 3.0.3
info:
  title: Leadstaker API
  version: 1.0.0
  description: Public REST API for Leadstaker projects.
servers:
  - url: https://n-api.leadstaker.com
    description: Production
security: []
tags:
  - name: Fields
    description: >-
      Custom field definitions, both the built-in ones and the ones a project
      creates.
  - name: Field groups
    description: Sections that organize custom fields in the interface.
  - name: Deals
    description: Opportunities moving through a pipeline, each tied to a contact.
  - name: Contacts
    description: >-
      People inside a project, holding the custom field values collected about
      them.
  - name: Messages
    description: Individual messages inside a chat, inbound and outbound.
  - name: Chats
    description: Conversations with a contact over a connected channel.
  - name: Loss reasons
    description: The catalog of reasons a deal can be marked as lost.
  - name: Pipelines
    description: Ordered sets of stages a deal travels through.
  - name: Stages
    description: Steps inside a pipeline, including the built-in open and closed ones.
  - name: Tags
    description: Free-form labels attached to deals.
  - name: Notes
    description: >-
      Free text attached to a contact or a deal, written by a user, an agent, or
      the system.
paths:
  /v1/notes:
    get:
      tags:
        - Notes
      summary: List notes
      description: >-
        Answers with a bare array of notes, without an envelope or pagination
        fields.
      operationId: getNotes
      parameters:
        - name: '[limit]'
          in: query
          required: false
          description: How many records to return, at most 100.
          schema:
            type: integer
            minimum: 1
            maximum: 100
        - name: '[offset]'
          in: query
          required: false
          description: How many records to skip.
          schema:
            type: integer
            minimum: 0
        - name: '[project]'
          in: query
          required: false
          description: Comma-separated list of fields to return, e.g. `id,createdAt`.
          schema:
            type: string
            minLength: 1
        - name: '[with]'
          in: query
          required: false
          description: Comma-separated list of relations to populate.
          schema:
            type: string
            minLength: 1
        - name: '[logic]'
          in: query
          required: false
          description: How to combine the filters. Defaults to AND.
          schema:
            type: string
            enum:
              - AND
              - OR
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    archivedAt:
                      type: string
                      format: date-time
                    createdAt:
                      type: string
                      format: date-time
                    updatedAt:
                      type: string
                      format: date-time
                    projectId:
                      type: string
                      minLength: 1
                    content:
                      type: string
                      minLength: 1
                    entityId:
                      type: string
                      minLength: 1
                    author:
                      anyOf:
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - USER
                            id:
                              type: string
                              minLength: 1
                          required:
                            - type
                            - id
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - AGENT
                          required:
                            - type
                          additionalProperties: false
                        - type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - SYSTEM
                          required:
                            - type
                          additionalProperties: false
                    entityType:
                      type: string
                      minLength: 1
                  required:
                    - id
                    - createdAt
                    - updatedAt
                    - projectId
                    - content
                    - entityId
                    - author
                    - entityType
                  additionalProperties: false
              example:
                - id: 671784c9b2f1dd0016cae5f2
                  projectId: 665f1c2e8a94b70012d4e9a1
                  content: Cliente pediu retorno na segunda de manhã.
                  entityId: 6715be3a9c40aa0013d8e5c2
                  author:
                    type: USER
                    id: 664d9e0b7c83aa0010f1c2d3
                  entityType: DEAL
                  createdAt: '2026-01-15T10:05:00.000Z'
                  updatedAt: '2026-01-15T10:05:00.000Z'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      required:
        - errorCode
        - message
        - status
      properties:
        errorCode:
          type: string
        message:
          type: string
        status:
          type: integer
        errors:
          type: array
          items:
            type: object
            required:
              - field
              - code
              - message
            properties:
              field:
                type: string
              code:
                type: string
              message:
                type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````