> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # List messages of a protocol > Lists the messages of a protocol, in chronological order. ## OpenAPI ````yaml /api-reference/openapi.en.yaml get /protocols/{protocol}/messages openapi: 3.0.3 info: title: Connecta DESK Public API version: 1.0.0 description: >- Public API of Connecta DESK, available at `/api/v1`. Access uses a token generated in the tokens module. Each token has permissions per **module × method**, and every list read is paginated. ## Authentication ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` The token belongs to a **company**, not to a user. The company used is always the token's company, so sending `companyId` in the body has no effect. A missing, invalid, revoked or expired token gets the same `401` response. ## Order of checks 1. **token** → `401` 2. **active company** → `403` 3. **API enabled on the plan** → `403 ERR_API_NOT_ENABLED` (does not apply to on-premise) 4. **company rate limit** → `429` 5. **token permission** → `403 ERR_API_FORBIDDEN_SCOPE` ## User ids Every user id in the API is the user's id **in this company**, the same one `GET /users` returns. This applies to what the API returns (`user.id`, `assignedTo.id`, `userCreated.id`) and to what it accepts (`userId`, `userIds`, `assignedToUserId` and the `{id}` in user routes). The same person can work in several companies, with a different name and profile in each one, and has a different id in each company. An id that does not belong to this company returns `404`, with the same message as an id that does not exist. ## Pagination Every list `GET` is paginated. The `meta` contains only `page`, `perPage` and `hasMore`, without the total number of records. To go through everything, keep advancing `page` while `hasMore` is `true`. ## Idempotency Optional on `POST`/`PUT`, through the `Idempotency-Key` header. If you repeat the call with the same key and the same body, you get the stored response (with `Idempotent-Replay: true`). With the same key and a different body, the response is `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Production security: - apiToken: [] tags: - name: contacts description: Contact records, extra fields and marketing source. - name: tickets x-displayName: Tickets description: Opening, transferring, closing and wrap-up of tickets. - name: messages description: Asynchronous sending and reading of messages. - name: tags description: Tags and their link to tickets. - name: queues description: Service queues and their agents. - name: wrapups description: Wrap-up types. - name: users description: Agents and administrators. - name: schedules description: Scheduled messages. - name: quick-messages description: Quick replies. - name: campaigns description: Bulk sending. - name: crm description: Boards, stages, cards and metrics. - name: channels description: Channels (read only). - name: reports description: Reports and dashboards. - name: products description: Product catalog, categories and sales performance. - name: custom-fields description: Custom fields for contacts and cards, plus company-wide global variables. - name: profiles description: Company permission profiles (read only). - name: webchat description: >- Native webchat from your own system: open a visitor session, send and read messages. The token needs the `webchat` scope (GET and POST). paths: /protocols/{protocol}/messages: parameters: - name: protocol in: path required: true schema: type: string example: '2026090800125' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' get: tags: - messages summary: List messages of a protocol description: Lists the messages of a protocol, in chronological order. responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Message' meta: $ref: '#/components/schemas/PageMeta' '404': $ref: '#/components/responses/NotFound' components: parameters: page: name: page in: query description: Page number, starting at 1. An invalid value is treated as 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Number of items per page. The maximum depends on the environment (default 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: Message: type: object properties: id: type: string ticketId: type: integer description: Ticket the message belongs to. example: 9034 contactId: type: integer nullable: true example: 1042 body: type: string fromMe: type: boolean description: >- `true` when the message was sent by the company; `false` when it came from the contact. ack: type: integer description: >- Message delivery status: -1 = failed, 0 = pending, 1 = sent, 2 = server, 3 = delivered, 4 = read. read: type: boolean description: The message was read by the recipient. mediaType: type: string nullable: true mediaUrl: type: string nullable: true isDeleted: type: boolean description: The message was deleted. isEdited: type: boolean description: The message was edited after being sent. isLog: type: boolean storyMention: type: boolean storyReply: type: boolean quotedMsgId: type: string nullable: true providerMessageId: type: string nullable: true log: type: string nullable: true description: >- Error reported by the provider when `ack = -1`. It shows why the send failed. createdAt: type: string format: date-time updatedAt: type: string format: date-time example: id: 3EB0C2A1F45D9B7E1122 ticketId: 5120 contactId: 842 body: Perfeito, vou querer o tamanho M fromMe: false ack: 3 read: true mediaType: null mediaUrl: null isDeleted: false isEdited: false isLog: false storyMention: false storyReply: false quotedMsgId: null providerMessageId: 3EB0C2A1F45D9B7E1122 log: null createdAt: '2026-08-18T14:27:10.421Z' updatedAt: '2026-08-18T14:27:11.002Z' PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Whether there are more records beyond this page. example: true example: page: 1 perPage: 20 hasMore: true Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Fixed error code, so your system can handle each case. example: ERR_API_FORBIDDEN_SCOPE message: type: string details: {} responses: NotFound: description: >- The resource does not exist or belongs to another company. For security, the response is the same in both cases. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_NOT_FOUND message: Registro não encontrado. securitySchemes: apiToken: type: http scheme: bearer description: API token in the `sk_live_…` format. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.