---
title: "Listar notas internas"
method: GET
path: "/v1/session/{id}/note"
tags: ["Conversas"]
---

# Listar notas internas

`GET /v1/session/{id}/note`

Este endpoint permite a listagem de notas internas de um atendimento.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `PageNumber` integer
- `PageSize` integer
- `OrderBy` string
- `OrderDirection` 'ASCENDING' | 'DESCENDING'
- `CreatedAt.Before` string, date-time
- `CreatedAt.After` string, date-time
- `UpdatedAt.Before` string, date-time
- `UpdatedAt.After` string, date-time

## Response `200`

Success

- PublicMessageDTOPublicPageListDTO
  - `pageNumber` integer — Número da página a ser obtida.
  - `pageSize` integer — Tamanho da página a ser obtida.
  - `orderBy` string, nullable — Nome do campo para ser utilizado como pivô da ordenação.
  - `orderDirection` 'ASCENDING' | 'DESCENDING', nullable — Determina se a ordenação deve ser crescente ou decrescente.
  - `items` PublicMessageDTO[], nullable
    - `id` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `timestamp` string, date-time, nullable
    - `type` 'TEXT' | 'STICKER' | 'IMAGE' | 'AUDIO' | 'VIDEO' | 'DOCUMENT' | 'CONTACT' | 'LOCATION' | 'LIST' | 'BUTTONS' | 'TRANSITION' | 'TRACK' | 'NOTE'
    - `senderId` string, nullable
    - `sessionId` string, uuid
    - `templateId` string, uuid, nullable
    - `userId` string, uuid, nullable
    - `direction` 'FROM_HUB' | 'TO_HUB'
    - `status` 'PROCESSING' | 'SAVED' | 'QUEUED' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'DELETED' | 'WAIT_REPLY'
    - `origin` 'DEFAULT' | 'CAMPAIGN' | 'OFFICE_HOURS' | 'BOT' | 'API' | 'PAYMENT' | 'GATEWAY'
    - `text` string, nullable
    - `fileId` string, uuid, nullable
    - `refId` string, uuid, nullable
    - `readContactAt` string, date-time, nullable
    - `details` PublicMessageDetailsDTO
      - `file` PublicFileDTO
        - `id` string, uuid
        - `companyId` string, uuid, nullable
        - `userId` string, uuid, nullable
        - `name` string, nullable
        - `extension` string, nullable
        - `mimeType` string, nullable
        - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
        - `publicUrl` string, nullable
        - `publicUrlDownload` string, nullable
        - `size` integer
        - `isThumbnail` boolean
        - `thumbnail` PublicFileThumbnailDTO
          - `id` string, uuid
          - `publicUrl` string, nullable
      - `files` PublicFileDTO[], nullable
        - `id` string, uuid
        - `companyId` string, uuid, nullable
        - `userId` string, uuid, nullable
        - `name` string, nullable
        - `extension` string, nullable
        - `mimeType` string, nullable
        - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
        - `publicUrl` string, nullable
        - `publicUrlDownload` string, nullable
        - `size` integer
        - `isThumbnail` boolean
        - `thumbnail` PublicFileThumbnailDTO
          - `id` string, uuid
          - `publicUrl` string, nullable
      - `fileAsLink` PublicMessageFileAsLinkDTO
        - `file` PublicFileDTO
          - `id` string, uuid
          - `companyId` string, uuid, nullable
          - `userId` string, uuid, nullable
          - `name` string, nullable
          - `extension` string, nullable
          - `mimeType` string, nullable
          - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
          - `publicUrl` string, nullable
          - `publicUrlDownload` string, nullable
          - `size` integer
          - `isThumbnail` boolean
          - `thumbnail` PublicFileThumbnailDTO
            - `id` string, uuid
            - `publicUrl` string, nullable
        - `shortUrl` string, nullable
      - `location` PublicMessageLocationDTO
        - `latitude` number, double
        - `longitude` number, double
        - `address` string, nullable
        - `name` string, nullable
        - `url` string, nullable
      - `contact` PublicMessageContactDTO
        - `name` string, nullable
        - `email` string, nullable
        - `phoneNumber` string, nullable
        - `phoneNumberFormatted` string, nullable
      - `errors` PublicMessageErrorDTO[], nullable
        - `date` string, date-time
        - `origin` string, nullable
        - `key` string, nullable
        - `text` string, nullable
      - `footerText` string, nullable
      - `utm` PublicUtmDTO
        - `sourceId` string, nullable
        - `source` string, nullable
        - `clid` string, nullable
        - `medium` string, nullable
        - `campaign` string, nullable
        - `content` string, nullable
        - `headline` string, nullable
        - `term` string, nullable
        - `referralUrl` string, nullable
      - `payTransactionId` string, uuid, nullable
      - `reactionToContact` 'SMILE' | 'SAD' | 'WOW' | 'LOVE', nullable
      - `reactionFromContact` string, nullable
      - `track` PublicMessageTrackDTO
        - `id` string, uuid
        - `createdAt` string, date-time
        - `type` 'ACCESS_PAGE' | 'START_CHAT' | 'SAVE_CONTACT'
        - `pageTitle` string, nullable
        - `pageUrl` string, nullable
        - `pageUtm` PublicUtmDTO
          - `sourceId` string, nullable
          - `source` string, nullable
          - `clid` string, nullable
          - `medium` string, nullable
          - `campaign` string, nullable
          - `content` string, nullable
          - `headline` string, nullable
          - `term` string, nullable
          - `referralUrl` string, nullable
        - `isMobileDevice` boolean
        - `formData` PublicMessageTrackFromDataDTO
          - `name` string, nullable
          - `email` string, nullable
          - `phoneNumber` string, nullable
          - `annotation` string, nullable
      - `transcription` PublicMsgTranscriptionDTO
        - `text` string, nullable
        - `processing` boolean
        - `error` boolean
      - `templateCategoryId` string, uuid, nullable
      - `templateCategoryName` string, nullable
      - `waitReply` boolean
    - `failedReason` string, nullable
    - `filesIds` string[], nullable
  - `totalItems` integer
  - `totalPages` integer
  - `hasMorePages` boolean

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/wts/apis/core.md) · [All operations](https://skmtc.net/wts/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wts/core/versions/1efd0a6ba643/schema)
