> ## 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 equipe do checklist

> Lista as pessoas da equipe do checklist, com a função de cada uma e, para quem não é gestor, quais avaliações vê e quais questionários pode usar. As unidades e os questionários atribuídos a cada pessoa vêm nas listagens de unidades e de questionários da equipe, pelo `user.id`. Até 100 registros por página; use `page` para as próximas.



## OpenAPI

````yaml /api-reference/openapi-v2.json get /api/v2/checklist/config/team-member/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
      questionários 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.
  - name: Arquivos
    description: >-
      Upload de arquivos para anexar nos endpoints de escrita da v2, em duas
      etapas: o upload devolve o id do arquivo, e o id vai no campo de anexos da
      escrita. O arquivo fica disponível até ser usado ou expirar, com até 100
      disponíveis; a listagem mostra os disponíveis, com a data de expiração, e
      eles podem ser removidos. 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/checklist/config/team-member/list:
    get:
      tags:
        - Checklist
      summary: Listar equipe do checklist
      description: >-
        Lista as pessoas da equipe do checklist, com a função de cada uma e,
        para quem não é gestor, quais avaliações vê e quais questionários pode
        usar. As unidades e os questionários atribuídos a cada pessoa vêm nas
        listagens de unidades e de questionários da equipe, pelo `user.id`. Até
        100 registros por página; use `page` para as próximas.
      operationId: listarEquipeChecklist
      parameters:
        - name: userId
          in: query
          schema:
            type: integer
          example: 55
          description: Id do usuário. Aceita um id só.
        - name: teamMemberType
          in: query
          schema:
            type: string
          description: >-
            Função na equipe. Aceita um valor, sem diferenciar maiúsculas de
            minúsculas.


            | Valor | Significado |

            | ----- | ----------- |

            | `MANAGER` | Gestor |

            | `ASSESSOR` | Avaliador |
          example: ASSESSOR
        - name: assessmentVisibility
          in: query
          schema:
            type: string
          description: >-
            Avaliações que a pessoa vê.


            | Valor | Significado |

            | ----- | ----------- |

            | `OWN` | Só as próprias |

            | `ALL_FROM_ASSIGNED_COMPANIES` | Todas as das unidades atribuídas a
            ela |


            O gestor (`MANAGER`) vem com `OWN`, embora a resposta não mostre o
            campo para ele.
          example: OWN
        - name: templateVisibility
          in: query
          schema:
            type: string
          description: >-
            Questionários que a pessoa pode usar.


            | Valor | Significado |

            | ----- | ----------- |

            | `ALL` | Todos os questionários |

            | `ASSIGNED_TEMPLATES` | Só os questionários atribuídos a ela |


            O gestor (`MANAGER`) vem com `ALL`, embora a resposta não mostre o
            campo para ele.
          example: ASSIGNED_TEMPLATES
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: Pessoas da equipe.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ChecklistMembroEquipeV2'
              example:
                - user:
                    id: 55
                    name: Carlos Mendes
                  teamMemberType: ASSESSOR
                  assessmentVisibility: OWN
                  templateVisibility: ASSIGNED_TEMPLATES
                - user:
                    id: 108
                    name: Renata Faria
                  teamMemberType: MANAGER
        '400':
          description: >-
            Valor inválido ou faltando. A API aponta um campo por vez, com a
            mensagem em inglês: corrija o campo citado e reenvie, até receber
            200. `Invalid value, please verify.` indica um valor em formato
            inesperado. Quando o serviço do Checklist recusa o pedido, a
            mensagem é a dele.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroChecklistV2'
              example:
                error: >-
                  'teamMemberType' field only accepts the following values:
                  MANAGER, ASSESSOR.
                dateTime: '2026-11-03T14:20:00Z'
        '401':
          $ref: '#/components/responses/TokenInvalido'
        '403':
          $ref: '#/components/responses/SemPermissaoChecklist'
        '404':
          $ref: '#/components/responses/NaoEncontradoChecklist'
        '429':
          $ref: '#/components/responses/LimiteDeRequisicoes'
        5XX:
          description: >-
            Falha inesperada no servidor ao listar a equipe. Acontece quando o
            serviço do Checklist responde com erro, não responde em 30 segundos
            ou não está configurado para a rede, ou quando a função de uma
            pessoa da equipe não é reconhecida. Repita com espera crescente, a
            partir de 1 segundo; persistindo, acione o suporte com o `dateTime`
            da resposta, o endpoint e os dados enviados. Se a falha acontecer na
            validação do token, o corpo é `{"error": "Internal Server Error."}`,
            sem `dateTime`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErroChecklistV2'
              example:
                error: Internal Server Error
                dateTime: '2026-11-03T14:20:00Z'
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:
    ChecklistMembroEquipeV2:
      type: object
      description: Pessoa da equipe do checklist.
      properties:
        user:
          type: object
          description: >-
            Usuário da equipe. `id` e `name` vêm `null` quando o usuário não é
            encontrado.
          properties:
            id:
              type: integer
              description: >-
                Id do usuário. É o valor de `userId` nas listagens de unidades e
                de questionários da equipe.
              example: 55
            name:
              type: string
              description: Nome do usuário.
              example: Carlos Mendes
        teamMemberType:
          $ref: '#/components/schemas/FuncaoMembroEquipeV2'
          description: Função na equipe.
        assessmentVisibility:
          $ref: '#/components/schemas/VisibilidadeAvaliacaoEquipeV2'
          description: >-
            Permite ver avaliações de outros membros da equipe com as mesmas
            empresas atribuídas ou somente as próprias avaliações. Campo vem
            apenas para `teamMemberType=ASSESSOR`.
        templateVisibility:
          $ref: '#/components/schemas/VisibilidadeQuestionarioEquipeV2'
          description: >-
            Permite ver todos questionários ou somente os atribuídos. Campo vem
            apenas para `teamMemberType=ASSESSOR`.
    ErroChecklistV2:
      type: object
      description: >-
        Corpo de erro do módulo de Checklist. 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 da falha, em inglês. O texto pode mudar: nunca o use como
            condição de código.
          example: '''assessmentId'' is required.'
        dateTime:
          type: string
          format: date-time
          description: >-
            Data e hora do erro, em UTC. Formato exato `yyyy-MM-ddTHH:mm:ssZ`.
            Informe esse valor ao suporte.
          example: '2026-11-03T14:20:00Z'
    FuncaoMembroEquipeV2:
      type: string
      description: |-
        Função da pessoa na equipe do checklist.

        | Valor | Significado |
        | ----- | ----------- |
        | `MANAGER` | Gestor |
        | `ASSESSOR` | Avaliador |
      example: ASSESSOR
    VisibilidadeAvaliacaoEquipeV2:
      type: string
      description: >-
        Avaliações que a pessoa vê.


        | Valor | Significado |

        | ----- | ----------- |

        | `OWN` | Só as próprias |

        | `ALL_FROM_ASSIGNED_COMPANIES` | Todas as das unidades atribuídas a ela
        |
      example: OWN
    VisibilidadeQuestionarioEquipeV2:
      type: string
      description: |-
        Questionários que a pessoa pode usar.

        | Valor | Significado |
        | ----- | ----------- |
        | `ALL` | Todos os questionários |
        | `ASSIGNED_TEMPLATES` | Só os questionários atribuídos a ela |
      example: ASSIGNED_TEMPLATES
    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:
    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.
    SemPermissaoChecklist:
      description: >-
        O módulo de Checklist recusou o acesso ao recurso pedido. Repetir a
        chamada sem mudança devolve o mesmo erro.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErroChecklistV2'
          example:
            error: Unauthorized
            dateTime: '2026-11-03T14:20:00Z'
    NaoEncontradoChecklist:
      description: >-
        Registro não encontrado no módulo de Checklist. Confira o id informado;
        reenviar sem corrigir devolve o mesmo erro.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErroChecklistV2'
          example:
            error: Not Found
            dateTime: '2026-11-03T14:20:00Z'
    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.
  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.