> ## 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 avaliações de checklist na API v2 do SULTS > Lista as avaliações de checklist, cada uma com o modelo aplicado, a unidade avaliada, o responsável, a situação, a pontuação e o resumo do check-in e do check-out. A pontuação (`score` e `maxScore`) não vem enquanto a avaliação está em aberto, e `checkInEnabled` e `checkOutEnabled` só vêm nas avaliações agendadas. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/checklist/assessment/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/checklist/assessment/list: get: tags: - Checklist summary: Listar avaliações de checklist description: >- Lista as avaliações de checklist, cada uma com o modelo aplicado, a unidade avaliada, o responsável, a situação, a pontuação e o resumo do check-in e do check-out. A pontuação (`score` e `maxScore`) não vem enquanto a avaliação está em aberto, e `checkInEnabled` e `checkOutEnabled` só vêm nas avaliações agendadas. operationId: listarAvaliacoesChecklistV2 parameters: - name: id in: query schema: type: integer description: Código da avaliação. example: 1201 - name: assigneeUserId in: query schema: type: integer description: Código do usuário responsável pela avaliação. example: 55 - name: status in: query schema: type: string enum: - SCHEDULED - IN_PROGRESS - SUBMITTED - CLOSED description: >- Situação da avaliação. Aceita um valor por vez: valores separados por vírgula respondem 400. | Valor | Significado | | ----- | ----------- | | `SCHEDULED` | Agendado | | `IN_PROGRESS` | Em andamento | | `SUBMITTED` | Em revisão | | `CLOSED` | Concluído | example: CLOSED - name: templateId in: query schema: type: integer description: Código do modelo de checklist. example: 25 - name: scheduledDateAfter in: query schema: type: string format: date-time description: >- Traz as avaliações agendadas para esta data ou depois dela, em UTC ISO 8601. example: '2026-10-01T03:00:00Z' - name: scheduledDateBefore in: query schema: type: string format: date-time description: >- Traz as avaliações agendadas para esta data ou antes dela, em UTC ISO 8601. example: '2026-10-31T02:59:59Z' - name: active in: query schema: type: boolean description: >- Filtro de cancelamento. `true` (padrão) lista só as avaliações ativas; `false` lista só as canceladas. example: true - $ref: '#/components/parameters/Page' responses: '200': description: Lista de avaliações. content: application/json: schema: type: array items: $ref: '#/components/schemas/AvaliacaoV2' example: - id: 1201 scheduledDate: '2026-10-06T13:00:00Z' earlyStartEnabled: true template: id: 25 name: Inspeção de qualidade da unidade asset: id: 19 name: Cozinha status: CLOSED active: true createdAt: '2026-10-01T18:20:00Z' startedAt: '2026-10-06T13:01:10Z' score: '520' maxScore: '660.5' scoreZeroed: false company: id: 12 name: Sabor Mineiro Savassi cnpj: '42274696002561' createdByUser: id: 108 name: Renata Faria assigneeUser: id: 55 name: Carlos Mendes campaign: id: 7 name: Auditoria do segundo semestre checkInEnabled: true checkOutEnabled: true checkIn: id: 130 checkedInAt: '2026-10-06T13:00:03Z' checkOut: id: 63 checkedOutAt: '2026-10-06T14:42:18Z' '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: AvaliacaoV2: type: object description: 'Avaliação de checklist: a execução de um modelo em uma unidade.' properties: id: type: integer description: Código da avaliação. example: 1201 scheduledDate: type: - string - 'null' description: Data agendada, em UTC ISO 8601. example: '2026-10-06T13:00:00Z' format: date-time earlyStartEnabled: type: - boolean - 'null' description: Permite iniciar a avaliação antes da data agendada. example: true template: $ref: '#/components/schemas/ChecklistModeloResumoV2' description: Modelo aplicado. asset: description: Objeto em avaliação. oneOf: - $ref: '#/components/schemas/ChecklistObjetoV2' - type: 'null' status: $ref: '#/components/schemas/SituacaoAvaliacaoV2' description: Situação da avaliação. active: type: boolean description: 'Indica se a avaliação está ativa. `false`: avaliação cancelada.' example: true createdAt: type: - string - 'null' description: Data de criação, em UTC ISO 8601. example: '2026-10-01T18:20:00Z' format: date-time startedAt: type: - string - 'null' description: Data de início, em UTC ISO 8601. example: '2026-10-06T13:01:10Z' format: date-time score: type: string description: >- Pontuação obtida. Vem como texto. Não vem enquanto a avaliação está em aberto. example: '520' maxScore: type: string description: >- Pontuação máxima possível. Vem como texto. Não vem enquanto a avaliação está em aberto. example: '660.5' scoreZeroed: type: - boolean - 'null' description: Indica se a pontuação da avaliação foi zerada. example: false company: $ref: '#/components/schemas/ChecklistUnidadeV2' description: Unidade avaliada. createdByUser: $ref: '#/components/schemas/ChecklistUsuarioV2' description: Usuário que criou a avaliação. assigneeUser: $ref: '#/components/schemas/ChecklistUsuarioV2' description: Responsável pela avaliação. campaign: description: Campanha da avaliação. oneOf: - $ref: '#/components/schemas/ChecklistCampanhaV2' - type: 'null' checkInEnabled: type: boolean description: Indica se a avaliação exige check-in. Só vem em avaliação agendada. example: true checkOutEnabled: type: boolean description: Indica se a avaliação exige check-out. Só vem em avaliação agendada. example: true checkIn: $ref: '#/components/schemas/ChecklistCheckinResumoV2' description: Check-in da avaliação. checkOut: $ref: '#/components/schemas/ChecklistCheckoutResumoV2' description: Check-out da avaliação. ChecklistModeloResumoV2: type: object description: Modelo de checklist (questionário) em forma resumida. properties: id: type: integer description: Código do modelo. example: 25 name: type: string description: Nome do modelo. example: Inspeção de qualidade da unidade ChecklistObjetoV2: type: object description: Objeto em avaliação. properties: id: type: integer description: Código do objeto. example: 19 name: type: string description: Nome do objeto. example: Cozinha SituacaoAvaliacaoV2: type: string enum: - SCHEDULED - IN_PROGRESS - SUBMITTED - CLOSED description: |- Situação da avaliação. | Valor | Significado | | ----- | ----------- | | `SCHEDULED` | Agendado | | `IN_PROGRESS` | Em andamento | | `SUBMITTED` | Em revisão | | `CLOSED` | Concluído | example: CLOSED ChecklistUnidadeV2: type: object description: Unidade avaliada. properties: id: type: integer description: Código da unidade. example: 12 name: type: string description: Nome da unidade. example: Sabor Mineiro Savassi cnpj: type: string description: CNPJ da unidade, sem máscara. example: '42274696002561' ChecklistUsuarioV2: type: object description: Usuário em forma resumida. properties: id: type: integer description: Código do usuário. example: 55 name: type: string description: Nome do usuário. example: Carlos Mendes ChecklistCampanhaV2: type: object description: Campanha da avaliação. properties: id: type: integer description: Código da campanha. example: 7 name: type: string description: Nome da campanha. example: Auditoria do segundo semestre ChecklistCheckinResumoV2: type: object description: Check-in em forma resumida. properties: id: type: integer description: Código do check-in. example: 130 checkedInAt: type: string description: Data do check-in, em UTC ISO 8601. example: '2026-10-06T13:00:03Z' format: date-time ChecklistCheckoutResumoV2: type: object description: Check-out em forma resumida. properties: id: type: integer description: Código do check-out. example: 63 checkedOutAt: type: string description: Data do check-out, em UTC ISO 8601. example: '2026-10-06T14:42:18Z' format: date-time 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.