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

# Listar pessoas do comunicado

> Lista as pessoas vinculadas a um comunicado, com a data de visualização e o registro de aceite. É o endpoint para acompanhar quem leu e quem confirmou a leitura dos comunicados marcados como obrigatórios. O parâmetro `announcementId` é obrigatório.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/comunicado/announcement/user/list
openapi: 3.1.0
info:
  title: API do SULTS v2
  version: '2.0'
  description: >-
    A nova geração da API do SULTS, em migração módulo a módulo (Compras
    primeiro). Autenticação por token v2 no cabeçalho `Authorization`; tokens v1
    não funcionam aqui. Nas requisições com corpo, envie `Content-Type:
    application/json;charset=UTF-8`.
  contact:
    name: Suporte SULTS
    url: https://ajuda.sults.com.br
servers:
  - url: https://api.sults.com.br
security:
  - apiKeyAuth: []
tags:
  - name: Produtos
    description: >-
      Cadastro, preço, estoque, variações e variantes de produto no módulo de
      Compras da v2. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada
      requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o
      prefixo `Bearer`. O token é gerado por um administrador na plataforma, em
      Segurança > API > Gestão de Tokens v2. O limite é de 2 requisições por
      segundo, por IP.
  - name: Mix de produtos
    description: >-
      Sortimento de produtos por empresa. Disponível apenas quando o recurso de
      mix está habilitado na plataforma, em Comercial > Configuração > Mix de
      produto. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada
      requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o
      prefixo `Bearer`. O token é gerado por um administrador na plataforma, em
      Segurança > API > Gestão de Tokens v2. O limite é de 2 requisições por
      segundo, por IP.
  - name: Pedidos e etapas
    description: >-
      Pedidos de compra da v2 e o fluxo de etapas, que é configurável por
      operação. A API do SULTS é REST sobre HTTPS e responde em JSON. Cada
      requisição leva o token no cabeçalho `Authorization`, enviado puro, sem o
      prefixo `Bearer`. O token é gerado por um administrador na plataforma, em
      Segurança > API > Gestão de Tokens v2. O limite é de 2 requisições por
      segundo, por IP.
  - name: Comunicados
    description: >-
      Comunicados publicados na plataforma, com o público de cada um, a
      confirmação de leitura e o conteúdo publicado. A API do SULTS é REST sobre
      HTTPS e responde em JSON. Cada requisição leva o token no cabeçalho
      `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é gerado
      por um administrador na plataforma, em Segurança > API > Gestão de Tokens
      v2. O limite é de 2 requisições por segundo, por IP.
  - name: Chamados
    description: >-
      Chamados da plataforma: abertura, timeline, interações, apoios, etiquetas,
      prazo e conclusão. A API do SULTS é REST sobre HTTPS e responde em JSON.
      Cada requisição leva o token no cabeçalho `Authorization`, enviado puro,
      sem o prefixo `Bearer`. O token é gerado por um administrador na
      plataforma, em Segurança > API > Gestão de Tokens v2. O limite é de 2
      requisições por segundo, por IP.
  - name: Checklist
    description: >-
      Avaliações de checklist com respostas, check-in e check-out, os modelos
      com seções e questões, e os planos de ação com a timeline. A API do SULTS
      é REST sobre HTTPS e responde em JSON. Cada requisição leva o token no
      cabeçalho `Authorization`, enviado puro, sem o prefixo `Bearer`. O token é
      gerado por um administrador na plataforma, em Segurança > API > Gestão de
      Tokens v2. O limite é de 2 requisições por segundo, por IP.
paths:
  /api/v2/comunicado/announcement/user/list:
    get:
      tags:
        - Comunicados
      summary: Listar pessoas do comunicado
      description: >-
        Lista as pessoas vinculadas a um comunicado, com a data de visualização
        e o registro de aceite. É o endpoint para acompanhar quem leu e quem
        confirmou a leitura dos comunicados marcados como obrigatórios. O
        parâmetro `announcementId` é obrigatório.
      operationId: listarPessoasComunicado
      parameters:
        - name: announcementId
          in: query
          required: true
          schema:
            type: integer
          description: Código do comunicado.
          example: 10
        - name: userId
          in: query
          schema:
            type: integer
          description: Código da pessoa.
          example: 63
        - name: viewedAfter
          in: query
          schema:
            type: string
            format: date-time
          description: Traz apenas as visualizações a partir desta data, em UTC ISO 8601.
          example: '2026-05-10T12:31:45Z'
        - name: viewedBefore
          in: query
          schema:
            type: string
            format: date-time
          description: Traz apenas as visualizações até esta data, em UTC ISO 8601.
          example: '2026-05-10T12:31:45Z'
        - name: accepted
          in: query
          schema:
            type: boolean
          description: >-
            Filtra pelo aceite: `true` traz quem aceitou, `false` traz quem não
            aceitou.
          example: true
        - name: viewed
          in: query
          schema:
            type: boolean
          description: >-
            Filtra pela visualização: `true` traz quem visualizou, `false` traz
            quem não visualizou.
          example: true
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: Lista de pessoas do comunicado.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComunicadoPessoaV2'
              example:
                - user:
                    id: 63
                    name: User Xpto
                  viewed: true
                  viewedAt: '2026-08-10T02:00:00Z'
                  accepted: false
        '400':
          $ref: '#/components/responses/ErroValidacao'
        '401':
          $ref: '#/components/responses/TokenInvalido'
        '404':
          $ref: '#/components/responses/NaoEncontrado'
        '429':
          $ref: '#/components/responses/LimiteDeRequisicoes'
        5XX:
          $ref: '#/components/responses/ErroDoServidor'
components:
  parameters:
    Page:
      name: page
      in: query
      description: >-
        Número da página da listagem, começando em `0`. Incremente até a
        resposta vir vazia.
      schema:
        type: integer
        minimum: 0
        default: 0
      example: 0
  schemas:
    ComunicadoPessoaV2:
      type: object
      description: Pessoa vinculada a um comunicado, com o estado de leitura e aceite.
      properties:
        user:
          $ref: '#/components/schemas/ComunicadoUsuarioResumoV2'
        viewed:
          type: boolean
          description: Indica se a pessoa visualizou o comunicado.
          example: true
        viewedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            Data da visualização, em UTC ISO 8601. Nulo quando ainda não houve
            visualização.
          example: '2026-08-10T02:00:00Z'
        accepted:
          type: boolean
          description: >-
            Indica se a pessoa registrou o aceite. Relevante quando o comunicado
            tem `required` verdadeiro.
          example: false
    ComunicadoUsuarioResumoV2:
      type: object
      description: Usuário em forma resumida.
      properties:
        id:
          type: integer
          description: Código do usuário.
          example: 1
        name:
          type: string
          description: Nome do usuário.
          example: Admin Xpto
    Erro:
      type: object
      description: >-
        Corpo padrão de erro da API. Não existe código de erro interno: decida a
        sua lógica pelo status HTTP e use a mensagem apenas para logs e
        diagnóstico.
      required:
        - error
      properties:
        error:
          type: string
          description: >-
            Mensagem legível, em português, descrevendo a falha. O texto pode
            mudar: nunca o use como condição de código.
          example: Campo supplierId não pode ser vazio ou nulo.
  responses:
    ErroValidacao:
      description: >-
        Erro de validação ou formato errado nos dados de entrada. A API aponta
        **um campo por vez**: corrija o campo indicado na mensagem, reenvie e
        repita até o 200.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error: Campo supplierId não pode ser vazio ou nulo.
    TokenInvalido:
      description: >-
        Token ausente ou inválido. Confira: copiado por completo, cabeçalho
        `Authorization` com o nome exato, valor sem o prefixo `Bearer` e gerado
        na **Gestão de Tokens v2** (tokens v1 não funcionam aqui). Sem retry
        automático. O corpo real é `{"error": "Acesso não autorizado."}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
          example:
            error: Acesso não autorizado.
    NaoEncontrado:
      description: >-
        Recurso inexistente, ou recurso condicionado desabilitado (por exemplo,
        endpoints de Mix sem o recurso de mix habilitado na operação). Reenviar
        sem corrigir devolve o mesmo erro.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
    LimiteDeRequisicoes:
      description: >-
        Limite de requisições excedido: **2 requisições por segundo, por IP**. A
        resposta é a página HTML padrão do servidor, não JSON, e não há o header
        `Retry-After`: trate pelo status 429, sem fazer parse do corpo, com
        espera crescente a partir de 1 segundo.
      content:
        text/html:
          schema:
            type: string
            description: >-
              Página HTML padrão do servidor. Não faça parse; decida pelo
              status.
    ErroDoServidor:
      description: >-
        Falha inesperada do servidor (raro). Repita com espera crescente;
        persistindo, acione o suporte com data, hora e endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Erro'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Token  gerado na Gestão de Tokens v2 do SULTS. Deve ser enviado no
        cabeçalho `Authorization` de todas as requisições.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.