Saltar para o conteúdo principal
GET
cURL

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, 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á incorreta, 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 o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.

Parâmetros de caminho

questionnaire_uuid
string<uuid>
obrigatório

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

Resposta

Detalhe completo do questionário incluindo o graph canónico, a visualização derivada sections, metadados de versão e is_editable.

Detalhe completo do questionário retornado pelos endpoints GET, POST (criar) e PATCH (atualizar).

questionnaire_id
string<uuid>

Identificador único do questionário. Utilize este id ao referenciar o questionário a partir de um fluxo ou em pedidos subsequentes de atualização/eliminação.

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

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

sections
object[]

Conteúdo do questionário agrupado em secçõ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 no local (versões de rascunho).

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