# SULTS Developers

> Documentação oficial da API REST do SULTS: entenda como a API funciona, escolha a versão e integre a sua rede

- [Como a API funciona](https://developers.sults.com.br/geral/como-a-api-funciona.md): Os conceitos que valem para qualquer versão da API do SULTS: REST sobre HTTPS, respostas em JSON, token no header e paginação nas listagens
- [Qual versão eu uso?](https://developers.sults.com.br/geral/qual-versao-eu-uso.md): A comparação entre a API v1 e a API v2 do SULTS por módulo, base de URL, paginação e gestão de token, para escolher a versão certa
- [Autenticação](https://developers.sults.com.br/geral/autenticacao.md): Como a API do SULTS autentica cada requisição: token gerado na plataforma, enviado puro no header Authorization, com gestões separadas por versão
- [Limites de requisição](https://developers.sults.com.br/geral/limites.md): O rate limit da API do SULTS: 2 requisições por segundo por IP, a resposta 429 e como aplicar backoff exponencial nas varreduras
- [Changelog](https://developers.sults.com.br/geral/changelog.md): Histórico de mudanças da API do SULTS e desta documentação, da mais recente para a mais antiga
- [Landing Pages](https://developers.sults.com.br/geral/sem-codigo/landing-pages.md): Como funcionam as landing pages do SULTS para captura de leads: criação, campos, integração via iframe e UTM Tags
- [Receber leads pelo Make](https://developers.sults.com.br/geral/sem-codigo/make.md): Como integrar o SULTS ao Make para receber leads de plataformas como RD Station, Facebook Leads e Google
- [Receber leads pelo Zapier](https://developers.sults.com.br/geral/sem-codigo/zapier.md): Como integrar o SULTS ao Zapier para receber leads de plataformas como RD Station, Facebook Leads e Google
- [API v1 do SULTS](https://developers.sults.com.br/v1/introducao.md): O que a API v1 do SULTS cobre: os 7 módulos da plataforma, o token da gestão v1 e por onde começar a integrar
- [Quickstart da API v1 do SULTS](https://developers.sults.com.br/v1/quickstart.md): Gere o token da v1, liste as unidades da sua rede e confirme a primeira resposta da API do SULTS, com exemplos em cinco linguagens
- [Crie o token da API v1 do SULTS](https://developers.sults.com.br/v1/criar-token.md): O passo a passo para gerar o token da API v1 do SULTS na Gestão de Tokens v1, com prints da plataforma
- [Autenticação na API v1 do SULTS](https://developers.sults.com.br/v1/autenticacao.md): Como a API do SULTS autentica cada requisição: geração de tokens, v1 vs v2, guarda segura em produção e rotação
- [Convenções da API v1 do SULTS](https://developers.sults.com.br/v1/convencoes.md): As regras que valem para a API inteira: URLs base, formato JSON, datas em UTC, campos sem máscara e paginação
- [Erros da API v1 do SULTS](https://developers.sults.com.br/v1/erros.md): Os status HTTP reais da API do SULTS, o formato do corpo de erro e como tratar cada falha na sua integração
- [Postman e Insomnia na API v1](https://developers.sults.com.br/v1/postman.md): Importe a spec OpenAPI da API do SULTS no Postman ou no Insomnia e teste todos os endpoints em um clique
- [Listar unidades](https://developers.sults.com.br/v1/api-reference/unidades/listar-unidades.md): Lista as unidades cadastradas na plataforma do SULTS. Por padrão, somente unidades com a situação **ativa** são retornadas. As unidades são **ordenadas pelo nome fantasia**.
- [Listar colaboradores](https://developers.sults.com.br/v1/api-reference/unidades/listar-colaboradores.md): Lista as pessoas cadastradas nas unidades na plataforma do SULTS. Somente pessoas com a situação **ativa** e que tenham um **relacionamento ativo com uma unidade ativa** são retornadas. As pessoas são **ordenadas pelo nome**.
- [Listar chamados na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/chamados/listar-chamados.md): Lista os chamados criados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Criar chamado na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/chamados/criar-chamado.md): Cria um chamado dentro da plataforma do SULTS.
- [Listar timeline de chamado na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/chamados/listar-timeline-de-chamado.md): Lista a timeline (interações e ações realizadas) de um chamado específico na plataforma do SULTS.
- [Concluir chamado na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/chamados/concluir-chamado.md): Conclui um chamado dentro da plataforma do SULTS.
- [Listar avaliações de checklist na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/checklist/listar-avaliacoes-de-checklist.md): Lista as avaliações de checklist criadas na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar respostas de uma avaliação na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/checklist/listar-respostas-de-uma-avaliacao.md): Lista as questões e respostas de uma avaliação de checklist. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar checkin de uma avaliação na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/checklist/listar-checkin-de-uma-avaliacao.md): Busca o checkin de uma avaliação de checklist.
- [Listar checkout de uma avaliação na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/checklist/listar-checkout-de-uma-avaliacao.md): Busca o checkout de uma avaliação de checklist.
- [Buscar detalhes de um plano de ação](https://developers.sults.com.br/v1/api-reference/checklist/buscar-detalhes-de-um-plano-de-acao.md): Busca um plano de ação criado na plataforma do SULTS.
- [Listar interações de um plano de ação na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/checklist/listar-interacoes-de-um-plano-de-acao.md): Lista as interações de um plano de ação. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar produtos na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/compras/listar-produtos.md): Lista os produtos criados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Cadastrar produto na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/compras/cadastrar-produto.md): Cadastra um produto na plataforma do SULTS.
- [Buscar produto pelo id](https://developers.sults.com.br/v1/api-reference/compras/buscar-produto-pelo-id.md): Busca um produto criado na plataforma do SULTS.
- [Editar cadastro do produto na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/compras/editar-cadastro-do-produto.md): Edita um produto na plataforma do SULTS.
- [Editar condição de venda do produto](https://developers.sults.com.br/v1/api-reference/compras/editar-condicao-de-venda-do-produto.md): Edita as informações referentes à condição de venda do produto na plataforma do SULTS.
- [Listar pedidos na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/compras/listar-pedidos.md): Busca os pedidos cadastrados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Editar pedido](https://developers.sults.com.br/v1/api-reference/compras/editar-pedido.md): Cancela, reativa ou troca a situação de um pedido na plataforma do SULTS.
- [Listar produtos do pedido na API v1 do SULTS](https://developers.sults.com.br/v1/api-reference/compras/listar-produtos-do-pedido.md): Busca os produtos de um pedido na plataforma do SULTS.
- [Listar projetos em implantação](https://developers.sults.com.br/v1/api-reference/implantacao/listar-projetos-em-implantacao.md): Lista os projetos do módulo de Implantação criados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar tarefas dos projetos em implantação](https://developers.sults.com.br/v1/api-reference/implantacao/listar-tarefas-dos-projetos-em-implantacao.md): Lista as tarefas dos projetos no módulo de Implantação. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar projetos](https://developers.sults.com.br/v1/api-reference/projetos/listar-projetos.md): Lista os projetos criados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar tarefas em projetos](https://developers.sults.com.br/v1/api-reference/projetos/listar-tarefas-em-projetos.md): Lista as tarefas dos projetos no módulo de Projetos. A busca é **paginada** e limitada a **100 registros** por página.
- [Listar negócios](https://developers.sults.com.br/v1/api-reference/expansao/listar-negocios.md): Lista os negócios criados ou importados na plataforma do SULTS. A busca é **paginada** e limitada a **100 registros** por página.
- [Criar negócio](https://developers.sults.com.br/v1/api-reference/expansao/criar-negocio.md): Cria um negócio (lead) dentro da plataforma do SULTS.
- [Listar timeline de negócio](https://developers.sults.com.br/v1/api-reference/expansao/listar-timeline-de-negocio.md): Lista a timeline (interações e ações realizadas) de um negócio específico na plataforma do SULTS.
- [Dicionário: Chamados v1](https://developers.sults.com.br/v1/dicionario/chamados.md): Todos os códigos numéricos do módulo de Chamados: situação, tipo do chamado e tipos de interação da timeline
- [Dicionário: Checklist v1](https://developers.sults.com.br/v1/dicionario/checklist.md): Todos os códigos numéricos do módulo de Checklist: situações de avaliação e plano de ação, e os 16 tipos de resposta
- [Dicionário: Compras v1](https://developers.sults.com.br/v1/dicionario/compras.md): Os códigos numéricos do módulo de Compras: situação do pedido e o estado de cancelamento
- [Dicionário: Expansão](https://developers.sults.com.br/v1/dicionario/expansao.md): Os códigos numéricos do módulo de Expansão: temperatura e situação do negócio, tipos da timeline e das atividades
- [Dicionário: Projetos e Implantação](https://developers.sults.com.br/v1/dicionario/projetos-e-implantacao.md): Os códigos numéricos de Projetos e Implantação: situação e prioridade da tarefa, cálculo de prazo e tipos de predecessora
- [API v2 do SULTS](https://developers.sults.com.br/v2/introducao.md): O que a API v2 do SULTS cobre hoje: os módulos de Compras, Comunicados, Chamados e Checklist, o token da gestão v2 e o que muda em relação à v1
- [Quickstart da API v2 do SULTS](https://developers.sults.com.br/v2/quickstart.md): Gere o token da v2, liste os produtos do módulo de Compras e confirme a primeira resposta, com exemplos em cinco linguagens
- [Crie o token da API v2 do SULTS](https://developers.sults.com.br/v2/criar-token.md): O passo a passo para gerar o token de acesso à API v2 do SULTS na Gestão de Tokens v2
- [Autenticação na API v2 do SULTS](https://developers.sults.com.br/v2/autenticacao.md): Como gerar o token v2 do SULTS, o fluxo de exibição única e o envio no cabeçalho Authorization
- [Convenções da API v2 do SULTS](https://developers.sults.com.br/v2/convencoes.md): As regras que valem para toda a API v2: URL base, formato JSON, datas, paginação por página e limites de requisição
- [Erros da API v2 do SULTS](https://developers.sults.com.br/v2/erros.md): Os status HTTP da plataforma SULTS, o formato do corpo de erro e como tratar cada falha na sua integração v2
- [Postman e Insomnia na API v2](https://developers.sults.com.br/v2/postman.md): Importe a spec OpenAPI da API v2 do SULTS e teste os 45 endpoints em um clique
- [Listar produtos na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/produtos/listar-produtos.md): Lista os produtos cadastrados na plataforma do SULTS. Por padrão, somente produtos **ativos** são retornados.
- [Cadastrar produto na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/produtos/cadastrar-produto.md): Cadastra um produto na plataforma do SULTS. Os identificadores de categoria e fornecedor são obtidos na própria plataforma (Comercial > Configuração > Categoria e Comercial > Fornecedor).
- [Editar cadastro do produto na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/produtos/editar-cadastro-do-produto.md): Edita o cadastro de um produto existente. Em caso de sucesso, a resposta é o status 200 sem corpo adicional; em caso de falha, o corpo traz os detalhes do erro.
- [Ativar produto](https://developers.sults.com.br/v2/api-reference/produtos/ativar-produto.md): Ativa um produto. A listagem de produtos traz por padrão só os ativos, então um produto inativo só aparece nela depois de ativado ou com o filtro `active=false`. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Inativar produto](https://developers.sults.com.br/v2/api-reference/produtos/inativar-produto.md): Inativa um produto. Se o produto estiver em algum carrinho, ele é removido do carrinho. Produtos inativos deixam de aparecer na listagem padrão de produtos, que traz só os ativos. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Listar preços do produto](https://developers.sults.com.br/v2/api-reference/produtos/listar-precos-do-produto.md): Lista os preços de um produto por fornecedor, mix e variante.
- [Editar preço do produto](https://developers.sults.com.br/v2/api-reference/produtos/editar-preco-do-produto.md): Edita o preço e as regras de compra de um produto. Para o pedido ser válido, `orderProductQuantityMin` e `purchaseQuantityLimit` devem ser múltiplos de `orderProductQuantityStep`.
- [Listar estoque do produto](https://developers.sults.com.br/v2/api-reference/produtos/listar-estoque-do-produto.md): Lista o estoque de um produto, com o detalhamento por mix e variante quando o controle usa esses níveis.
- [Editar estoque do produto](https://developers.sults.com.br/v2/api-reference/produtos/editar-estoque-do-produto.md): Edita a quantidade em estoque e a data de reestoque de um produto, no nível exigido pelo `inventoryScope`.
- [Listar variações do produto](https://developers.sults.com.br/v2/api-reference/produtos/listar-variacoes-do-produto.md): Lista as variações de um produto (por exemplo, Tamanho ou Cor) com as suas opções. Por padrão, somente variações **ativas** são retornadas.
- [Listar variantes do produto](https://developers.sults.com.br/v2/api-reference/produtos/listar-variantes-do-produto.md): Lista as variantes de um produto: cada variante é uma combinação concreta de opções de variação (por exemplo, Tamanho Pequeno + Cor Cinza).
- [Listar mix](https://developers.sults.com.br/v2/api-reference/mix-de-produtos/listar-mix.md): Lista os mix (sortimentos) de produtos criados na plataforma. Por padrão, somente mix **ativos** são retornados. Disponível apenas quando o recurso de Mix está habilitado na plataforma (Comercial > Configuração > Mix de produto).
- [Listar produtos do mix](https://developers.sults.com.br/v2/api-reference/mix-de-produtos/listar-produtos-do-mix.md): Lista os produtos vinculados aos mix, com o produto completo aninhado. Disponível apenas quando o recurso de Mix está habilitado na plataforma (Comercial > Configuração > Mix de produto).
- [Adicionar produto ao mix](https://developers.sults.com.br/v2/api-reference/mix-de-produtos/adicionar-produto-ao-mix.md): Adiciona um produto a um mix existente. Disponível apenas quando o recurso de Mix está habilitado na plataforma (Comercial > Configuração > Mix de produto).
- [Listar empresas do mix](https://developers.sults.com.br/v2/api-reference/mix-de-produtos/listar-empresas-do-mix.md): Lista as empresas (unidades) vinculadas aos mix, com a data de vínculo. Disponível apenas quando o recurso de Mix está habilitado na plataforma (Comercial > Configuração > Mix de produto).
- [Remover produto do mix](https://developers.sults.com.br/v2/api-reference/mix-de-produtos/remover-produto-do-mix.md): Remove um produto de um mix existente. Disponível apenas quando o recurso de Mix está habilitado na plataforma (Comercial > Configuração > Mix de produto).
- [Listar etapas de pedido](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/listar-etapas-de-pedido.md): Lista as etapas do fluxo de pedidos configurado na plataforma, com nome, cor e posição. Por padrão, somente etapas **ativas** são retornadas.
- [Listar pedidos na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/listar-pedidos.md): Lista os pedidos da plataforma, com etapa atual, empresa, fornecedor, métodos de pagamento e entrega, e endereço de entrega.
- [Listar produtos do pedido na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/listar-produtos-do-pedido.md): Lista os itens de um pedido, com preço unitário, quantidades e a combinação de variações escolhida.
- [Editar etapa do pedido](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/editar-etapa-do-pedido.md): Move um pedido para outra etapa do fluxo configurado. As etapas disponíveis vêm da listagem de etapas de pedido.
- [Concluir pedido](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/concluir-pedido.md): Conclui um pedido na plataforma.
- [Cancelar pedido](https://developers.sults.com.br/v2/api-reference/pedidos-e-etapas/cancelar-pedido.md): Cancela um pedido na plataforma. Só é possível cancelar pedidos com a situação OPEN.
- [Listar comunicados](https://developers.sults.com.br/v2/api-reference/comunicados/listar-comunicados.md): Lista os comunicados criados na plataforma, com categoria, autor, janela de publicação, público e as opções de envio por e-mail. Por padrão retorna apenas os comunicados ativos; use `active=false` para ver os inativos.
- [Listar pessoas do comunicado](https://developers.sults.com.br/v2/api-reference/comunicados/listar-pessoas-do-comunicado.md): 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.
- [Listar conteúdo do comunicado](https://developers.sults.com.br/v2/api-reference/comunicados/listar-conteudo-do-comunicado.md): Retorna o conteúdo publicado de um comunicado: o título, o corpo em HTML e a lista de anexos com link de download. Diferente dos outros dois endpoints do módulo, a resposta é um objeto único, não um array, e não há paginação. O parâmetro `announcementId` é obrigatório.
- [Listar chamados na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/chamados/listar-chamados.md): Lista os chamados da plataforma, com solicitante, responsável, unidade, departamento de destino, assunto, apoios, etiquetas, prazos e situação. Sem o filtro `status`, a resposta traz só os chamados em aberto (`NEW`, `IN_PROGRESS`, `AWAITING_REQUESTER` e `AWAITING_ASSIGNEE`): para ver resolvidos e co…
- [Listar timeline de chamado na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/chamados/listar-timeline-de-chamado.md): Lista a timeline de um chamado: as interações e cada mudança registrada (prazo, responsável, assunto, apoios e conclusão), com o autor e a data de cada evento. O campo `type` diz o que aconteceu e quais campos acompanham o evento: a interação vem em `comment`, a troca de assunto em `previousCategory…
- [Criar chamado na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/chamados/criar-chamado.md): Abre um chamado em nome de um solicitante, com a mensagem inicial em HTML. A direção define quem abre e quem atende: entre administradores (`ADMIN_TO_ADMIN`), da unidade para a administradora (`COMPANY_TO_ADMIN`) ou da administradora para a unidade (`ADMIN_TO_COMPANY`). Responsável, departamentos, a…
- [Adicionar interação no chamado](https://developers.sults.com.br/v2/api-reference/chamados/adicionar-interacao-no-chamado.md): Registra uma interação na timeline do chamado, com o conteúdo em HTML, pública ou privada. No mesmo envio, o campo opcional `status` muda a situação do chamado; `CLOSED` não é aceito aqui, e para concluir use o endpoint de concluir chamado. A resposta traz o código da interação criada.
- [Adicionar apoio no chamado](https://developers.sults.com.br/v2/api-reference/chamados/adicionar-apoio-no-chamado.md): Adiciona uma pessoa como apoio no atendimento do chamado, opcionalmente vinculada a um departamento. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Remover apoio do chamado](https://developers.sults.com.br/v2/api-reference/chamados/remover-apoio-do-chamado.md): Remove uma pessoa do apoio no atendimento do chamado. Os dados vão na query string. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Adicionar etiqueta no chamado](https://developers.sults.com.br/v2/api-reference/chamados/adicionar-etiqueta-no-chamado.md): Adiciona uma etiqueta ao chamado. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Remover etiqueta do chamado](https://developers.sults.com.br/v2/api-reference/chamados/remover-etiqueta-do-chamado.md): Remove uma etiqueta do chamado. Os dados vão na query string. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Editar prazo do chamado](https://developers.sults.com.br/v2/api-reference/chamados/editar-prazo-do-chamado.md): Altera o prazo do chamado e registra quem fez a mudança. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Concluir chamado na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/chamados/concluir-chamado.md): Conclui um chamado e registra quem concluiu. A avaliação de satisfação é opcional: nota de 1 a 5 em `satisfactionRating` e comentário em `satisfactionComment`, que só é considerado quando a nota é enviada. Em caso de sucesso, a resposta é o status 200 sem corpo adicional.
- [Listar avaliações de checklist na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/listar-avaliacoes-de-checklist.md): 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…
- [Listar respostas de uma avaliação na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/listar-respostas-de-uma-avaliacao.md): Lista as respostas de uma avaliação, uma por questão, com a questão, a seção, o tipo da questão, a pontuação, o comentário, os anexos e os planos de ação gerados pela resposta. A pontuação (`score` e `maxScore`) vem como texto e não vem em avaliação agendada. O parâmetro `assessmentId` é obrigatório…
- [Listar checkin de uma avaliação na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/listar-checkin-de-uma-avaliacao.md): Retorna o check-in de uma avaliação: data, navegador ou aplicativo usado, comentário, localização, assinaturas e anexos. Apesar do `/list` no caminho, a resposta é um objeto único, não um array, e não há paginação. O parâmetro `assessmentId` é obrigatório.
- [Listar checkout de uma avaliação na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/listar-checkout-de-uma-avaliacao.md): Retorna o check-out de uma avaliação: data, navegador ou aplicativo usado, comentário, localização, assinaturas, anexos e as pessoas com quem o resultado foi compartilhado. Apesar do `/list` no caminho, a resposta é um objeto único, não um array, e não há paginação. O parâmetro `assessmentId` é obri…
- [Importar avaliação de checklist na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/importar-avaliacao-de-checklist.md): Registra na plataforma uma avaliação de checklist com a data agendada, as datas de início e de envio, o check-in, o check-out e as respostas informados no corpo. O modelo (`templateId`), as questões (`templateQuestionId`) e as opções (`answerTemplateOptionId`) vêm dos endpoints de listagem de modelo…
- [Listar modelos de checklist](https://developers.sults.com.br/v2/api-reference/checklist/listar-modelos-de-checklist.md): 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…
- [Listar seções de um modelo](https://developers.sults.com.br/v2/api-reference/checklist/listar-secoes-de-um-modelo.md): Lista as seções de um modelo de checklist, com a posição de cada uma e se aceita ser marcada como não aplicável. O parâmetro `templateId` é obrigatório.
- [Listar questões de um modelo](https://developers.sults.com.br/v2/api-reference/checklist/listar-questoes-de-um-modelo.md): Lista as questões de um modelo de checklist, com o tipo, a seção, a pontuação máxima, se a resposta é obrigatória e, nas questões de opções, as opções de resposta com peso e pontuação em `typeSettings.option`. Nas questões sem opções, `typeSettings` vem como array vazio (`[]`). O parâmetro `template…
- [Listar planos de ação](https://developers.sults.com.br/v2/api-reference/checklist/listar-planos-de-acao.md): Lista os planos de ação gerados a partir das respostas de avaliação, no formato 5W2H (`what`, `why`, `whenDate`, `whoUser`, `how` e `howMuch`; o onde não vem na resposta), com a resposta e a avaliação de origem, a situação e as etiquetas. As datas `whenDate` e `whenDeadlineDate` vêm em yyyy-MM-dd; a…
- [Listar interações de um plano de ação na API v2 do SULTS](https://developers.sults.com.br/v2/api-reference/checklist/listar-interacoes-de-um-plano-de-acao.md): Lista a timeline de um plano de ação: comentários, mudanças de situação, anexos e mudanças de prazo, com o autor de cada evento. O campo `type` diz o que aconteceu. O parâmetro `actionPlanId` é obrigatório.
- [Dicionário: Compras v2](https://developers.sults.com.br/v2/dicionario/compras.md): Os valores de situação e escopo da API v2: status de pedido, status de venda, inventoryScope e as etapas configuráveis
- [Dicionário: Comunicados v2](https://developers.sults.com.br/v2/dicionario/comunicados.md): Os valores do módulo de Comunicados na API v2: perfis de visibilidade e os campos booleanos de leitura, aceite e envio por e-mail
- [Dicionário: Chamados v2](https://developers.sults.com.br/v2/dicionario/chamados.md): Os valores do módulo de Chamados na API v2: situação, direção e origem do chamado, e os tipos de evento da timeline
- [Dicionário: Checklist v2](https://developers.sults.com.br/v2/dicionario/checklist.md): Os valores do módulo de Checklist na API v2: situação da avaliação e do plano de ação, tipos de questão, perfis, anexos e eventos

## OpenAPI Specs

- [openapi-v2](/api-reference/openapi-v2.json)
- [openapi](/api-reference/openapi.json)


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