Listar questões de um questionário

Lista as questões de um questionário de checklist, com o tipo, a seção, a pontuação máxima, se a resposta é obrigatória e as opções de resposta com peso e pontuação em typeSettings.option. typeSettings vem como objeto sempre que a questão tem lista de opções, mesmo vazia, e como array vazio ([]) nas demais. Sem os filtros active e sectionActive, vêm só as questões ativas de seções ativas. O parâmetro templateId é obrigatório. Até 100 registros por página; use page para as próximas.

GET

api

checklist

template

question

list

Listar questões de um questionário

curl --request GET \
  --url https://api.sults.com.br/api/v2/checklist/template/question/list \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.sults.com.br/api/v2/checklist/template/question/list"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/api/v2/checklist/template/question/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/api/v2/checklist/template/question/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/api/v2/checklist/template/question/list");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 2,
    "title": "As estantes estão limpas?",
    "descriptionHtml": "<p>Verificar prateleiras superiores e inferiores.</p>",
    "type": "RATING_QUALITY_3",
    "typeSettings": {
      "option": [
        {
          "id": 5296,
          "name": "Bom",
          "attachmentRequired": false,
          "actionPlanRequired": false,
          "weight": 3,
          "score": 30
        },
        {
          "id": 5297,
          "name": "Regular",
          "attachmentRequired": false,
          "actionPlanRequired": false,
          "weight": 2,
          "score": 20
        },
        {
          "id": 5298,
          "name": "Ruim",
          "attachmentRequired": true,
          "actionPlanRequired": true,
          "weight": 1,
          "score": 10
        }
      ]
    },
    "order": 0,
    "active": true,
    "maxScore": 30,
    "required": true,
    "commentEnabled": true,
    "notApplicableEnabled": false,
    "section": {
      "id": 5132,
      "name": "Estoque seco",
      "order": 0,
      "active": true
    }
  },
  {
    "id": 3,
    "title": "Qual a temperatura registrada na câmara fria?",
    "descriptionHtml": "",
    "type": "TEXT_SHORT",
    "typeSettings": [],
    "order": 1,
    "active": true,
    "maxScore": 0,
    "required": true,
    "commentEnabled": false,
    "notApplicableEnabled": false,
    "section": {
      "id": 5132,
      "name": "Estoque seco",
      "order": 0,
      "active": true
    }
  }
]

{
  "error": "'templateId' is required.",
  "dateTime": "2026-11-03T14:20:00Z"
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Unauthorized",
  "dateTime": "2026-11-03T14:20:00Z"
}

{
  "error": "Not Found",
  "dateTime": "2026-11-03T14:20:00Z"
}

<string>

{
  "error": "Internal Server Error",
  "dateTime": "2026-11-03T14:20:00Z"
}

Authorizations

Authorization

string

header

required

Token gerado na Gestão de Tokens v2 do SULTS. Deve ser enviado no cabeçalho Authorization de todas as requisições.

Query Parameters

templateId

integer

required

Id do questionário de checklist.

integer

Id da questão.

sectionId

integer

Id da seção.

required

boolean

Filtra pelas questões de resposta obrigatória.

notApplicableEnabled

boolean

Filtra pelas questões que aceitam ser marcadas como não aplicáveis.

active

boolean

Filtra pelas questões ativas (true, o padrão).

sectionActive

boolean

Filtra pelas questões de seções ativas (true, o padrão).

page

integer

default:0

Número da página da listagem, começando em 0. Incremente até a resposta vir vazia.

Required range: x >= 0

Response

Questões do questionário.

integer

Id da questão.

Example:

2

title

string

Título da questão.

Example:

"As estantes estão limpas?"

descriptionHtml

string | null

Orientação da questão, em HTML.

Example:

"<p>Verificar prateleiras superiores e inferiores.</p>"

type

string

Tipo da questão. Os mesmos valores vêm nas questões do questionário e nas respostas da avaliação.

Valor	Significado
`TEXT_SHORT`	Texto curto
`TEXT_LONG`	Texto longo
`INTEGER`	Número inteiro
`DECIMAL`	Número decimal
`CONFORMITY`	Conformidade
`DATE`	Data
`RATING_NUMERIC_10`	Barra deslizante com valor inteiro
`UPLOAD_FILE`	Upload de arquivo
`UPLOAD_IMAGE`	Upload de imagem
`YES_NO`	Sim ou não
`RATING_STAR_5`	Nível de qualidade em 5 estrelas
`RATING_QUALITY_3`	Nível de qualidade com 3 opções
`RATING_QUALITY_5`	Nível de qualidade com 5 opções
`CURRENCY`	Valor monetário
`CUSTOM_SINGLE_CHOICE`	Valores personalizados, uma escolha
`CUSTOM_MULTI_CHOICE`	Valores personalizados, múltipla escolha

Example:

"RATING_QUALITY_3"

typeSettings

Configuração do tipo da questão. Quando a questão tem lista de opções, é um objeto com as opções de resposta em option, mesmo que a lista esteja vazia; nas demais, é um array vazio ([]).

Show child attributes

order

integer | null

Posição da questão na seção, a partir de 0.

Example:

0

active

boolean

Indica se a questão está ativa.

Example:

true

maxScore

integer

Pontuação máxima da questão.

Example:

30

required

boolean

Indica se a resposta é obrigatória.

Example:

true

commentEnabled

boolean

Indica se a questão aceita comentário.

Example:

true

notApplicableEnabled

boolean

Indica se a questão aceita ser marcada como não aplicável.

Example:

false

section

object

Seção da questão.

Show child attributes

Listar questões de um questionário

curl --request GET \
  --url https://api.sults.com.br/api/v2/checklist/template/question/list \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.sults.com.br/api/v2/checklist/template/question/list"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.sults.com.br/api/v2/checklist/template/question/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sults.com.br/api/v2/checklist/template/question/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

using RestSharp;


var options = new RestClientOptions("https://api.sults.com.br/api/v2/checklist/template/question/list");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

[
  {
    "id": 2,
    "title": "As estantes estão limpas?",
    "descriptionHtml": "<p>Verificar prateleiras superiores e inferiores.</p>",
    "type": "RATING_QUALITY_3",
    "typeSettings": {
      "option": [
        {
          "id": 5296,
          "name": "Bom",
          "attachmentRequired": false,
          "actionPlanRequired": false,
          "weight": 3,
          "score": 30
        },
        {
          "id": 5297,
          "name": "Regular",
          "attachmentRequired": false,
          "actionPlanRequired": false,
          "weight": 2,
          "score": 20
        },
        {
          "id": 5298,
          "name": "Ruim",
          "attachmentRequired": true,
          "actionPlanRequired": true,
          "weight": 1,
          "score": 10
        }
      ]
    },
    "order": 0,
    "active": true,
    "maxScore": 30,
    "required": true,
    "commentEnabled": true,
    "notApplicableEnabled": false,
    "section": {
      "id": 5132,
      "name": "Estoque seco",
      "order": 0,
      "active": true
    }
  },
  {
    "id": 3,
    "title": "Qual a temperatura registrada na câmara fria?",
    "descriptionHtml": "",
    "type": "TEXT_SHORT",
    "typeSettings": [],
    "order": 1,
    "active": true,
    "maxScore": 0,
    "required": true,
    "commentEnabled": false,
    "notApplicableEnabled": false,
    "section": {
      "id": 5132,
      "name": "Estoque seco",
      "order": 0,
      "active": true
    }
  }
]

{
  "error": "'templateId' is required.",
  "dateTime": "2026-11-03T14:20:00Z"
}

{
  "error": "Acesso não autorizado."
}

{
  "error": "Unauthorized",
  "dateTime": "2026-11-03T14:20:00Z"
}

{
  "error": "Not Found",
  "dateTime": "2026-11-03T14:20:00Z"
}

<string>

{
  "error": "Internal Server Error",
  "dateTime": "2026-11-03T14:20:00Z"
}