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

# List notes

> Returns a list of notes. Uses cursor pagination.



## OpenAPI

````yaml /openapi-private.json get /notes
openapi: 3.1.0
info:
  title: Spott API Reference
  version: '0.1'
servers:
  - url: https://api.gospott.com
security: []
tags: []
paths:
  /notes:
    get:
      tags:
        - Notes
      summary: List notes
      description: Returns a list of notes. Uses cursor pagination.
      operationId: getNotes
      parameters:
        - name: limit
          required: false
          in: query
          description: 'Number of notes to return per page (min: 1, max: 50, default: 25).'
          schema:
            minimum: 1
            maximum: 50
            default: 25
            example: 25
            type: integer
        - name: cursor
          required: false
          in: query
          description: >-
            Base64-encoded cursor for pagination. Use the nextCursor value from
            a previous response to fetch the next page. Omit for the first page.
          schema:
            type: string
        - name: modifiedSince
          required: false
          in: query
          description: >-
            Filter notes modified on or after this date. Useful for incremental
            synchronization. Defaults to beginning of time if not provided.
          schema:
            $ref: '#/components/schemas/DateISO'
            default: '1970-01-01T00:00:00.000Z'
            example: '2024-11-01T00:00:00.000Z'
        - name: modifiedUntil
          required: false
          in: query
          description: >-
            Filter notes modified on or before this date. Useful for bounded
            synchronization snapshots. If omitted, no upper bound is applied.
          schema:
            $ref: '#/components/schemas/DateISO'
            example: '2024-11-30T23:59:59.999Z'
        - name: candidateId
          required: false
          in: query
          description: Filter notes linked to this candidate.
          schema:
            type: string
        - name: clientContactId
          required: false
          in: query
          description: Filter notes linked to this client contact.
          schema:
            type: string
        - name: source
          required: false
          in: query
          description: Filter notes by source (e.g. phone, inPerson, onlineMeeting).
          schema:
            type: string
            enum:
              - phone
              - phoneInbound
              - phoneOutbound
              - inPerson
              - onlineMeeting
              - callAttempted
        - name: labelIds
          required: false
          in: query
          description: Filter notes that have any of the given label IDs.
          schema:
            example:
              - label-123
              - label-456
            type: array
            items:
              type: string
      responses:
        '200':
          description: >-
            Successfully retrieved notes. Returns items array with pagination
            info containing cursor for the next page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNotesResponseDto'
        '400':
          description: >-
            Bad request - invalid query parameters (e.g., limit out of range,
            invalid date format)
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ExceptionBaseDto'
                  - type: object
                    properties:
                      statusCode:
                        type: number
                        example: 400
                      message:
                        type: string
                        example: Limit must be between 1 and 50
                      error:
                        type: string
                        example: Bad Request
        '401':
          description: Unauthorized - invalid or missing authentication
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
        '500':
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseDto'
      security:
        - x-api-key: []
components:
  schemas:
    DateISO:
      id: DateISO
      format: date-time
      anyOf:
        - type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        - type: string
          format: date
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
    GetNotesResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/NoteDto'
        pageInfo:
          type: object
          properties:
            nextCursor:
              anyOf:
                - type: string
                - type: 'null'
            hasNextPage:
              type: boolean
          required:
            - nextCursor
            - hasNextPage
      required:
        - items
        - pageInfo
      id: PrivateGetNotesResponseDto
    ExceptionBaseDto:
      type: object
      properties:
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        message:
          type: string
        requestId:
          type: string
      required:
        - status
        - message
        - requestId
      id: ExceptionBaseDto
    NoteDto:
      type: object
      properties:
        id:
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
        content:
          type: string
        createdAt:
          $ref: '#/components/schemas/DateISO'
        lastEditedAt:
          $ref: '#/components/schemas/DateISO'
        createdBy:
          anyOf:
            - $ref: '#/components/schemas/UserBadgeDto'
            - type: 'null'
        editors:
          type: array
          items:
            $ref: '#/components/schemas/NoteEditorDto'
        links:
          type: array
          items:
            $ref: '#/components/schemas/NoteLinkDto'
        meeting:
          anyOf:
            - $ref: '#/components/schemas/NoteLinkedMeetingDto'
            - type: 'null'
        call:
          anyOf:
            - $ref: '#/components/schemas/NoteLinkedCallDto'
            - type: 'null'
        audioRecording:
          anyOf:
            - $ref: '#/components/schemas/NoteLinkedAudioRecordingDto'
            - type: 'null'
        type:
          type: string
          enum:
            - manual
            - aiSummary
        source:
          $ref: '#/components/schemas/NoteDtoSource'
        pinned:
          type: boolean
        shouldPoll:
          type: boolean
        labels:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              colorHex:
                type: string
            required:
              - id
              - name
              - colorHex
      required:
        - id
        - title
        - content
        - createdAt
        - lastEditedAt
        - createdBy
        - editors
        - links
        - meeting
        - call
        - audioRecording
        - type
        - source
        - pinned
        - shouldPoll
        - labels
      id: PrivateNoteDto
    UserBadgeDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        avatarUrl:
          anyOf:
            - type: string
            - type: 'null'
        deactivatedAt:
          anyOf:
            - $ref: '#/components/schemas/DateISO'
            - type: 'null'
      required:
        - id
        - name
        - avatarUrl
        - deactivatedAt
      id: PrivateUserBadgeDto
    NoteEditorDto:
      type: object
      properties:
        editedBy:
          $ref: '#/components/schemas/UserBadgeDto'
        editedAt:
          $ref: '#/components/schemas/DateISO'
      required:
        - editedBy
        - editedAt
      id: PrivateNoteEditorDto
    NoteLinkDto:
      oneOf:
        - $ref: '#/components/schemas/NoteLinkCandidateDto'
        - $ref: '#/components/schemas/NoteLinkVacancyDto'
        - $ref: '#/components/schemas/NoteLinkClientDto'
        - $ref: '#/components/schemas/NoteLinkApplicationDto'
        - $ref: '#/components/schemas/NoteLinkClientContactDto'
        - $ref: '#/components/schemas/NoteLinkInterviewDto'
        - $ref: '#/components/schemas/NoteLinkOpportunityDto'
      id: PrivateNoteLinkDto
    NoteLinkedMeetingDto:
      type: object
      properties:
        id:
          type: string
        meetingProvider:
          anyOf:
            - $ref: '#/components/schemas/MeetingProvider'
            - type: 'null'
        title:
          type: string
        startTime:
          $ref: '#/components/schemas/DateISO'
        endTime:
          $ref: '#/components/schemas/DateISO'
        hasTranscript:
          type: boolean
      required:
        - id
        - meetingProvider
        - title
        - startTime
        - endTime
        - hasTranscript
      id: PrivateNoteLinkedMeetingDto
    NoteLinkedCallDto:
      type: object
      properties:
        id:
          type: string
        provider:
          $ref: '#/components/schemas/TelecomProvider'
        startTime:
          $ref: '#/components/schemas/DateISO'
        endTime:
          $ref: '#/components/schemas/DateISO'
        hasTranscript:
          type: boolean
      required:
        - id
        - provider
        - startTime
        - endTime
        - hasTranscript
      id: PrivateNoteLinkedCallDto
    NoteLinkedAudioRecordingDto:
      type: object
      properties:
        id:
          type: string
        startTime:
          $ref: '#/components/schemas/DateISO'
        endTime:
          $ref: '#/components/schemas/DateISO'
        hasTranscript:
          type: boolean
      required:
        - id
        - startTime
        - endTime
        - hasTranscript
      id: PrivateNoteLinkedAudioRecordingDto
    NoteDtoSource:
      id: PrivateNoteDtoSource
      type:
        - string
        - 'null'
      enum:
        - phone
        - phoneInbound
        - phoneOutbound
        - inPerson
        - onlineMeeting
        - callAttempted
        - null
    NoteLinkCandidateDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - candidate
        candidate:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            middleName:
              anyOf:
                - type: string
                - type: 'null'
            secondLastName:
              anyOf:
                - type: string
                - type: 'null'
            avatarUrl:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - id
            - firstName
            - lastName
            - middleName
            - secondLastName
            - avatarUrl
      required:
        - id
        - noteId
        - entityType
        - candidate
      id: PrivateNoteLinkCandidateDto
    NoteLinkVacancyDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - vacancy
        vacancy:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
        client:
          $ref: '#/components/schemas/ClientBadgeDto'
      required:
        - id
        - noteId
        - entityType
        - vacancy
        - client
      id: PrivateNoteLinkVacancyDto
    NoteLinkClientDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - client
        client:
          $ref: '#/components/schemas/ClientBadgeDto'
      required:
        - id
        - noteId
        - entityType
        - client
      id: PrivateNoteLinkClientDto
    NoteLinkApplicationDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - application
        applicationId:
          type: string
      required:
        - id
        - noteId
        - entityType
        - applicationId
      id: PrivateNoteLinkApplicationDto
    NoteLinkClientContactDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - clientContact
        clientContact:
          type: object
          properties:
            id:
              type: string
            firstName:
              type: string
            lastName:
              type: string
            middleName:
              anyOf:
                - type: string
                - type: 'null'
            secondLastName:
              anyOf:
                - type: string
                - type: 'null'
            avatarUrl:
              anyOf:
                - type: string
                - type: 'null'
            candidateId:
              type: string
            companyId:
              type: string
            companyName:
              type: string
            companyLogoUrl:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - id
            - firstName
            - lastName
            - middleName
            - secondLastName
            - avatarUrl
            - candidateId
            - companyId
            - companyName
            - companyLogoUrl
      required:
        - id
        - noteId
        - entityType
        - clientContact
      id: PrivateNoteLinkClientContactDto
    NoteLinkInterviewDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - interview
        interviewId:
          type: string
      required:
        - id
        - noteId
        - entityType
        - interviewId
      id: PrivateNoteLinkInterviewDto
    NoteLinkOpportunityDto:
      type: object
      properties:
        id:
          type: string
        noteId:
          type: string
        entityType:
          type: string
          enum:
            - opportunity
        opportunity:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            company:
              $ref: '#/components/schemas/CompanyBadgeDto'
          required:
            - id
            - name
            - company
      required:
        - id
        - noteId
        - entityType
        - opportunity
      id: PrivateNoteLinkOpportunityDto
    MeetingProvider:
      id: PrivateMeetingProvider
      type:
        - string
        - 'null'
      enum:
        - googleMeet
        - zoom
        - microsoftTeams
        - audioFile
        - null
    TelecomProvider:
      type: string
      enum:
        - TELNYX
        - AIRCALL
        - RINGCENTRAL
        - RINGOVER
        - VOIPPLAY
        - DIALPAD
      id: TelecomProvider
    ClientBadgeDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        logoUrl:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - name
        - logoUrl
      id: PrivateClientBadgeDto
    CompanyBadgeDto:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        logoUrl:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - name
        - logoUrl
      id: PrivateCompanyBadgeDto
  securitySchemes:
    x-api-key:
      type: apiKey
      name: x-api-key
      in: header
      description: >-
        API key for authentication. Get your API key from Settings → API Keys in
        your Spott dashboard.

````