Pular para o conteúdo principal
GET
cURL

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

questionnaire_uuid
string<uuid>
obrigatório

UUID da versão do questionário (o valor uuid retornado pelo endpoint de listagem, também retornado como questionnaire_id nos endpoints de detalhe).

Resposta

Detalhes completos do questionário, incluindo o graph canônico, a visualização derivada sections, os metadados da versão e is_editable.

Detalhes completos do questionário retornados pelos endpoints GET, POST (criação) e PATCH (atualização).

questionnaire_id
string<uuid>

Identificador único do questionário. Use este id ao referenciar o questionário a partir de um fluxo ou em requisições posteriores de atualização/exclusão.

title
string
description
string | null
languages
string[]
default_language
string
is_active
boolean
is_simple_questionnaire
boolean
graph
object

Estrutura de grafo com start_node e o mapa de nós.

sections
object[]

Conteúdo do questionário agrupado em seções (derivado do grafo).

questionnaire_group_id
string<uuid>

Identificador estável que agrupa todas as versões do mesmo questionário.

version
integer
status
enum<string>
Opções disponíveis:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True quando o questionário ainda pode ser editado diretamente (versões de rascunho).

Última modificação em 1 de novembro de 2026