> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Listar questionários: API de formulários KYC > Obtenha todos os questionários KYC e formulários de conformidade da sua organização na Didit com um só pedido. Faturação por chamada. Prompt da API para listar questionários Copiar o prompt para a área de transferência \

\`List every Didit questionnaire (custom form) defined for my application through the Management API.

Endpoint:
GET https://verification.didit.me/v3/questionnaires/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Retrieve every questionnaire so I can render a picker in my back-office, sync ids into my config, or discover the questionnaire_id of a form created in the Console.
\- Use the returned questionnaire_id later as config.questionnaire_uuid on a QUESTIONNAIRE feature in a workflow (see POST /v3/workflows/).

Behavior:
\- Results are returned newest first (-created_at). The endpoint does not paginate today — all rows are returned in one response.
\- Each row is one version of a questionnaire group. questionnaire_group_id is the stable identifier shared by every version; version is the integer version number; status is "draft" or "published".
\- Workflows that reference a questionnaire group_id always resolve to the latest published version automatically.
\- is_editable: true means this row is a draft and can still be patched in place via PATCH /v3/questionnaires/{questionnaire_uuid}/.
\- question_types is an aggregated array of the form-element types present in each questionnaire (excluding section headers and separators) so you can label cards in the UI without a follow-up call.

Example call:
curl -X GET "https://verification.didit.me/v3/questionnaires/" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- uuid — per-version questionnaire id, used as path id in GET / PATCH / DELETE /v3/questionnaires/{questionnaire_uuid}/.
\- questionnaire_id / questionnaire_group_id — pass as config.questionnaire_uuid when attaching the questionnaire to a workflow.

Failure modes:
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope when the API key cannot list questionnaires for this application.
\- 429 — rate limited; back off and retry.

Side effects: none. This is a pure read.

For the full integration shape, see /integration/integration-prompt.`

\
Colar em ## OpenAPI ````yaml pt/openapi-25.json GET /v3/questionnaires/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/questionnaires/: get: tags: - Questionnaires summary: Listar questionários description: >- Liste os seus questionários, os mais recentes primeiro, num envelope de paginação limit/offset (`{count, next, previous, results}`, tamanho de página predefinido de 50). Cada linha é uma versão; `questionnaire_group_id` é o ID de grupo estável resolvido para a versão `published` mais recente. operationId: list_questionnaires parameters: - name: limit in: query required: false schema: type: integer default: 50 description: Tamanho da página (número de questionários por página). - name: offset in: query required: false schema: type: integer default: 0 description: Número de linhas a ignorar antes do primeiro questionário devolvido. responses: '200': description: >- Uma página de questionários ordenada por `created_at` descendente, envolvida no envelope de paginação. Cada item em `results` é um `QuestionnaireListItem`. content: application/json: schema: type: object properties: count: type: integer description: Número total de versões de questionários para a aplicação. next: type: string format: uri nullable: true description: URL da página seguinte, ou `null` na última página. previous: type: string format: uri nullable: true description: URL da página anterior, ou `null` na primeira página. results: type: array items: $ref: '#/components/schemas/QuestionnaireListItem' examples: One questionnaire: summary: Um questionário bilingue simples value: count: 1 next: null previous: null results: - uuid: 11111111-2222-3333-4444-555555555555 title: KYC Questionnaire description: Additional verification questions languages: - en - es default_language: en is_active: true is_simple_questionnaire: true created_at: '2026-04-23T09:55:00Z' updated_at: '2026-04-23T10:00:00Z' question_types: - SHORT_TEXT - MULTIPLE_CHOICE - FILE_UPLOAD workflow_names: [] questionnaire_group_id: 11111111-2222-3333-4444-555555555555 version: 1 status: published published_at: '2026-04-23T10:00:00Z' is_editable: false '403': description: >- Chave de API em falta, mal formatada, expirada ou com âmbito limitado a uma aplicação diferente. content: application/json: examples: Invalid token: value: detail: You do not have permission to perform this action. '429': description: Limite de pedidos excedido. Tente novamente com recuo exponencial. '500': description: >- Erro de servidor inesperado ao compilar a lista. Pode tentar novamente em segurança. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: cURL source: |- curl -X GET 'https://verification.didit.me/v3/questionnaires/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() for item in client.questionnaires.list(): print(item) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); for await (const item of didit.questionnaires.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Questionnaires.ListAutoPaging(ctx, didit.QuestionnairesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); for (var item : client.questionnaires().list()) { System.out.println(item); } - lang: php label: PHP source: |- questionnaires->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.questionnaires.list.auto_paging_each do |item| puts item.to_h end - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); await foreach (var item in await client.Questionnaires.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: QuestionnaireListItem: type: object description: Uma versão do questionário na vista de lista. properties: uuid: type: string format: uuid description: >- UUID por versão. Utilize como `{questionnaire_uuid}` para obter/atualizar/eliminar e como `questionnaire_uuid` na configuração da funcionalidade QUESTIONNAIRE de um fluxo. title: type: string description: type: string nullable: true languages: type: array items: type: string default_language: type: string is_active: type: boolean is_simple_questionnaire: type: boolean description: >- True para questionários lineares criados através desta API; false para questionários baseados em grafos construídos na consola. created_at: type: string format: date-time updated_at: type: string format: date-time question_types: type: array items: type: string description: >- Tipos de elementos em maiúsculas das perguntas que admitem resposta, pela ordem de criação (por exemplo, `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`). Elementos estruturais `SECTION_HEADER` e `SEPARATOR` são excluídos. Uma entrada por pergunta, pelo que os valores podem repetir-se. workflow_names: type: array items: type: string description: >- Nomes dos fluxos que utilizam este questionário. Atualmente sempre `[]` neste endpoint (preenchido apenas na listagem da Consola). questionnaire_group_id: type: string format: uuid description: >- Identificador estável que agrupa todas as versões do mesmo questionário. version: type: integer description: Número da versão dentro do grupo, começando em 1. status: type: string enum: - draft - published published_at: type: string format: date-time nullable: true description: Quando esta versão foi publicada. `null` para rascunhos. is_editable: type: boolean description: Verdadeiro quando esta versão é um `draft`. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.