Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

questionnaire_uuid
string<uuid>
required

Per-version UUID of the questionnaire (the uuid value returned by the list endpoint, also returned as questionnaire_id on detail endpoints).

Response

Full questionnaire detail including the canonical graph, the derived sections view, version metadata, and is_editable.

Full questionnaire detail returned from GET, POST (create) and PATCH (update) endpoints.

questionnaire_id
string<uuid>

Unique identifier of the questionnaire. Use this id when referencing the questionnaire from a workflow or in subsequent update/delete requests.

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

Graph structure with start_node and nodes map.

sections
object[]

Questionnaire content grouped into sections (derived from the graph).

questionnaire_group_id
string<uuid>

Stable identifier that groups all versions of the same questionnaire.

version
integer
status
enum<string>
Available options:
draft,
published
published_at
string<date-time> | null
is_editable
boolean

True when the questionnaire can still be edited in place (draft versions).