Listar questionários de checklist

Lista os questionários de checklist, 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. Sem o filtro active, vêm só os questionários ativos. Até 100 registros por página; use page para as próximas.

GET

api

checklist

template

list

Listar questionários de checklist

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

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

fetch('https://api.sults.com.br/api/v2/checklist/template/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/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/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": 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
    }
  }
]

{
  "error": "'assigneeRoleType' field only accepts the following values: ADMIN, COMPANY or ADMIN,COMPANY.",
  "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

string

Ids dos questionários, separados por vírgula (54,55).

Pattern: ^\d+(,\d+)*$

categoryId

string

Ids das categorias do questionário, separados por vírgula (4,6). Os ids vêm de GET /api/v2/checklist/template/category/list.

Pattern: ^\d+(,\d+)*$

createdAfter

string<date-time>

Traz os questionários criados nesta data ou depois dela, em UTC. Formato exato yyyy-MM-ddTHH:mm:ssZ.

createdBefore

string<date-time>

Traz os questionários criados nesta data ou antes dela, em UTC. Formato exato yyyy-MM-ddTHH:mm:ssZ.

active

boolean

Filtra pelos questionários ativos (true, o padrão).

checkInEnabled

boolean

Filtra pelos questionários com check-in.

checkOutEnabled

boolean

Filtra pelos questionários com check-out.

assigneeRoleType

string

Perfis de usuário que podem ser responsáveis pela avaliação. Aceita um valor ou os dois separados por vírgula (ADMIN,COMPANY), sem diferenciar maiúsculas de minúsculas.

Valor	Significado
`ADMIN`	Usuário administrador
`COMPANY`	Usuário de unidade

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

Lista de questionários.

integer

Id do questionário.

Example:

54

name

string

Nome do questionário.

Example:

"Inspeção de qualidade da unidade"

descriptionHtml

string | null

Descrição do questionário, em HTML.

Example:

"<p>Roteiro mensal de qualidade e limpeza.</p>"

createdAt

string<date-time>

Data de criação, em UTC. Formato exato yyyy-MM-ddTHH:mm:ssZ.

Example:

"2026-10-09T13:39:58Z"

maxScore

integer

Pontuação máxima do questionário. null quando o questionário não tem pontuação.

Example:

660

active

boolean

Indica se o questionário está ativo.

Example:

true

attachmentSource

string

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"

assigneeRoleType

string[]

Perfis de usuário que podem ser responsáveis pela avaliação. Não vem quando o perfil do questionário não é reconhecido.

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"]

category

object

Categoria do questionário.

Show child attributes

checkInEnabled

boolean

Indica se as avaliações do questionário têm check-in.

Example:

true

checkInSettings

object

O que o check-in exige.

Show child attributes

checkOutEnabled

boolean

Indica se as avaliações do questionário têm check-out.

Example:

true

checkOutSettings

object

O que o check-out exige.

Show child attributes

Listar questionários de checklist

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

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

fetch('https://api.sults.com.br/api/v2/checklist/template/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/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/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": 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
    }
  }
]

{
  "error": "'assigneeRoleType' field only accepts the following values: ADMIN, COMPANY or ADMIN,COMPANY.",
  "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"
}