> ## 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 v1 do SULTS > Lista as avaliações de checklist criadas na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. ## OpenAPI ````yaml /api-reference/openapi.json get /api/v1/checklist/avaliacao openapi: 3.1.0 info: title: API SULTS version: v1 description: >- API REST do SULTS. Todas as chamadas devem ser autenticadas por um token enviado, puro e sem o prefixo `Bearer`, no cabeçalho HTTP `Authorization`. As datas seguem o formato UTC ISO 8601 (`yyyy-MM-ddTHH:mm:ssZ`) e campos com máscara (CNPJ, telefone, CEP etc.) são retornados sem máscara. Endpoints de listagem paginados aceitam os parâmetros `start` e `limit`. contact: name: Suporte SULTS url: https://ajuda.sults.com.br servers: - url: https://api.sults.com.br description: Produção security: - apiKeyAuth: [] tags: - name: Unidades description: >- Unidades da rede e colaboradores ativos cadastrados no SULTS. Somente leitura: a API não grava unidades nem colaboradores. 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 v1. O limite é de 2 requisições por segundo, por IP. - name: Chamados description: >- Chamados abertos na plataforma e a timeline de cada um, com os endpoints de criação 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 v1. O limite é de 2 requisições por segundo, por IP. - name: Checklist description: >- Avaliações de checklist aplicadas nas unidades, com respostas, check-ins, check-outs e planos de açã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 v1. O limite é de 2 requisições por segundo, por IP. - name: Compras description: >- Pedidos de compra e catálogo de produtos da v1, incluindo o cadastro e a edição de produto e a edição de pedido. A v1 de Compras não recebe novas funcionalidades: mix de produtos, etapas de pedido e as próximas novidades do módulo estão só na API v2, que é a indicada para integrações novas de Compras. 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 v1. O limite é de 2 requisições por segundo, por IP. - name: implantacao description: >- Projetos de implantação de novas unidades e as tarefas de cada projeto. 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 v1. O limite é de 2 requisições por segundo, por IP. x-group: Implantação - name: Projetos description: >- Projetos da operação e as tarefas vinculadas a eles. 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 v1. O limite é de 2 requisições por segundo, por IP. - name: expansao description: >- Negócios do funil de Expansão e a timeline de cada um, com o endpoint de criação de negócio. 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 v1. O limite é de 2 requisições por segundo, por IP. x-group: Expansão paths: /api/v1/checklist/avaliacao: get: tags: - Checklist summary: Listar avaliações de checklist description: >- Lista as avaliações de checklist criadas na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página. operationId: listarAvaliacoesChecklist parameters: - $ref: '#/components/parameters/Start' - $ref: '#/components/parameters/Limit' - name: id in: query required: false description: Código da avaliação do Checklist schema: type: integer example: 1 - name: modeloId in: query required: false description: Código do modelo de Checklist schema: type: integer example: 4 - name: responsavelId in: query required: false description: Código da pessoa responsável pela avaliação schema: type: integer example: 8 - name: unidadeId in: query required: false description: Código da empresa da avaliação schema: type: integer example: 12 - name: situacao in: query required: false description: |- Situação da avaliação. | Valor | Significado | | ----- | ----------- | | 1 | Concluído | | 2 | Andamento | | 3 | Validação | schema: type: integer enum: - 1 - 2 - 3 example: 1 - name: dtFimStart in: query required: false description: >- Busca as avaliações com data de término a partir da data informada (UTC ISO 8601). schema: type: string format: date-time example: '2026-07-01T00:00:00Z' - name: dtFimEnd in: query required: false description: >- Busca as avaliações com data de término até a data informada (UTC ISO 8601). schema: type: string format: date-time example: '2026-07-31T23:59:59Z' responses: '200': description: Lista paginada de avaliações content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AvaliacaoChecklist' start: type: integer description: Página retornada limit: type: integer description: Registros por página totalPage: type: integer description: Quantidade de páginas disponíveis size: type: integer description: Quantidade de registros na página '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: Start: name: start in: query description: >- Número da página da listagem, começando em `0`. Incremente até a resposta vir vazia ou até atingir `totalPage`. schema: type: integer minimum: 0 default: 0 example: 0 Limit: name: limit in: query description: Quantidade de registros por página. O máximo aceito pela API é `100`. schema: type: integer minimum: 1 maximum: 100 default: 100 example: 100 schemas: AvaliacaoChecklist: type: object properties: id: type: integer description: Código da avaliação do Checklist example: 1 dtInicio: type: string format: date-time description: Data em que a avaliação foi iniciada (UTC ISO 8601) example: '2026-09-03T12:10:04Z' dtFim: type: string format: date-time description: Data em que a avaliação foi finalizada (UTC ISO 8601) example: '2026-09-03T13:27:40Z' dtCriacao: type: string format: date-time description: Data em que a avaliação foi criada (UTC ISO 8601) example: '2026-09-01T11:00:00Z' dtPrazo: type: string format: date-time description: Prazo da avaliação (UTC ISO 8601) example: '2026-09-05T21:00:00Z' pontuacaoAlcancada: type: number description: Pontuação alcançada na avaliação do Checklist example: 8.5 pontuacaoAlcancadaZerada: type: boolean description: Indica que a pontuação da avaliação foi zerada example: true pontuacaoMaxima: type: number description: Pontuação máxima que pode ser obtida na avaliação example: 8.5 permitidoAvaliacaoAntesDtPrazo: type: boolean description: Permitido fazer a avaliação antes do prazo example: true modelo: type: object description: Modelo de Checklist properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Auditoria de qualidade objeto: type: object description: Objeto que será avaliado properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Cozinha situacao: type: integer enum: - 1 - 2 - 3 description: |- Situação da avaliação de checklist. | Valor | Significado | |-------|-------------| | 1 | Concluído | | 2 | Andamento | | 3 | Validação | example: 1 unidade: type: object description: Unidade da avaliação properties: id: type: integer description: Código da unidade example: 1 nomeFantasia: type: string description: Nome fantasia da unidade example: Sabor Mineiro Savassi cnpj: type: string description: CNPJ da unidade example: '12345678000190' criacaoPessoa: type: object description: Pessoa que criou a avaliação properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Fernanda Rocha responsavel: type: object description: Pessoa responsável pela avaliação do Checklist properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Juliana Prado campanha: type: object description: Campanha à qual o Checklist pertence properties: id: type: integer description: Código example: 1 nome: type: string description: Nome example: Campanha de inverno 2026 checkinHabilitado: type: boolean description: Se `true`, habilitado fazer checkin na avaliação example: true checkoutHabilitado: type: boolean description: Se `true`, habilitado fazer checkout na avaliação example: true checkin: type: object description: Checkin da avaliação properties: id: type: integer description: Código do checkin example: 1 dtCheckin: type: string format: date-time description: Data do checkin (UTC ISO 8601) example: '2026-09-03T12:08:51Z' checkout: type: object description: Checkout da avaliação properties: id: type: integer description: Código do checkout example: 1 dtCheckout: type: string format: date-time description: Data do checkout (UTC ISO 8601) example: '2026-09-03T13:29:02Z' 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 responsavel 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 responsavel 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 v1** (tokens v2 não funcionam nesta API). 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 ou entidade inexistente (por exemplo, um `{id}` do caminho que não existe ou foi excluído no SULTS). 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 através do sistema 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.