> ## 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 modelos de checklist > Lista os modelos de checklist (questionários), com a pontuação máxima, os perfis que podem ser responsáveis pela avaliação, a origem dos anexos, a categoria e o que o check-in e o check-out exigem. Os filtros de check-in e check-out (`checkInEnabled` e `checkOutEnabled`) têm o mesmo nome dos campos da resposta. ## OpenAPI ````yaml /api-reference/openapi-v2.json get /api/v2/checklist/template/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/template/list: get: tags: - Checklist summary: Listar modelos de checklist description: >- Lista os modelos de checklist (questionários), com a pontuação máxima, os perfis que podem ser responsáveis pela avaliação, a origem dos anexos, a categoria e o que o check-in e o check-out exigem. Os filtros de check-in e check-out (`checkInEnabled` e `checkOutEnabled`) têm o mesmo nome dos campos da resposta. operationId: listarModelosChecklist parameters: - name: id in: query schema: type: integer description: Código do modelo. example: 54 - name: categoryId in: query schema: type: integer description: Código da categoria do modelo. example: 4 - name: createdAfter in: query schema: type: string format: date-time description: Traz os modelos criados nesta data ou depois dela, em UTC ISO 8601. example: '2026-10-01T03:00:00Z' - name: createdBefore in: query schema: type: string format: date-time description: Traz os modelos criados nesta data ou antes dela, em UTC ISO 8601. example: '2026-10-31T02:59:59Z' - name: active in: query schema: type: boolean description: Filtra pelos modelos ativos (`true`) ou inativos (`false`). example: true - name: checkInEnabled in: query schema: type: boolean description: Filtra pelos modelos com check-in. example: true - name: checkOutEnabled in: query schema: type: boolean description: Filtra pelos modelos com check-out. example: true - name: assigneeRoleType in: query schema: type: string enum: - ADMIN - COMPANY description: |- Perfil de usuário que pode ser responsável pela avaliação. | Valor | Significado | | ----- | ----------- | | `ADMIN` | Usuário administrador | | `COMPANY` | Usuário de unidade | example: ADMIN responses: '200': description: Lista de modelos. content: application/json: schema: type: array items: $ref: '#/components/schemas/ChecklistModeloV2' example: - id: 37 name: Inspeção de loja básico descriptionHtml: '' createdAt: '2018-08-29T20:31:42Z' maxScore: '470' active: true attachmentSource: CAMERA_AND_UPLOAD assigneeRoleType: - ADMIN - COMPANY category: id: 1 name: Padrão active: true checkInEnabled: true checkInSettings: commentRequired: true signatureRequired: true attachmentRequired: true geolocationRequired: true checkOutEnabled: true checkOutSettings: commentRequired: false signatureRequired: false attachmentRequired: false geolocationRequired: 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: schemas: ChecklistModeloV2: type: object description: >- Modelo de checklist (questionário): as seções e questões aplicadas nas avaliações. properties: id: type: integer description: Código do modelo. example: 54 name: type: string description: Nome do modelo. example: Inspeção de qualidade da unidade descriptionHtml: type: string description: Descrição do modelo, em HTML. example:

Roteiro mensal de qualidade e limpeza.

createdAt: type: string description: Data de criação, em UTC ISO 8601. example: '2026-10-09T13:39:58Z' format: date-time maxScore: type: string description: Pontuação máxima do modelo. Vem como texto. example: '660.5' active: type: boolean description: Indica se o modelo está ativo. example: true attachmentSource: $ref: '#/components/schemas/OrigemAnexoChecklistV2' description: De onde vêm os anexos das respostas. assigneeRoleType: type: array description: Perfis de usuário que podem ser responsáveis pela avaliação. items: $ref: '#/components/schemas/PerfilResponsavelChecklistV2' example: - ADMIN category: $ref: '#/components/schemas/ChecklistCategoriaModeloV2' description: Categoria do modelo. checkInEnabled: type: boolean description: Indica se as avaliações do modelo têm check-in. example: true checkInSettings: $ref: '#/components/schemas/ChecklistEtapaConfigV2' description: O que o check-in exige. checkOutEnabled: type: boolean description: Indica se as avaliações do modelo têm check-out. example: true checkOutSettings: $ref: '#/components/schemas/ChecklistEtapaConfigV2' description: O que o check-out exige. OrigemAnexoChecklistV2: type: string enum: - CAMERA_ONLY - CAMERA_AND_UPLOAD description: |- De onde vêm os anexos das respostas. | Valor | Significado | | ----- | ----------- | | `CAMERA_ONLY` | Somente câmera | | `CAMERA_AND_UPLOAD` | Câmera e upload | example: CAMERA_ONLY PerfilResponsavelChecklistV2: type: string enum: - ADMIN - COMPANY description: |- Perfil de usuário que pode ser responsável pela avaliação. | Valor | Significado | | ----- | ----------- | | `ADMIN` | Usuário administrador | | `COMPANY` | Usuário de unidade | example: ADMIN ChecklistCategoriaModeloV2: type: object description: Categoria do modelo de checklist. properties: id: type: integer description: Código da categoria. É o valor do filtro `categoryId`. example: 1 name: type: string description: Nome da categoria. example: Padrão active: type: boolean description: Indica se a categoria está ativa. example: true ChecklistEtapaConfigV2: type: object description: O que o check-in ou o check-out exige. properties: commentRequired: type: boolean description: Exige comentário. example: true signatureRequired: type: boolean description: Exige assinatura. example: true attachmentRequired: type: boolean description: Exige anexo. example: true geolocationRequired: type: boolean description: Exige a captura da localização. example: true 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.