> ## 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.

# List Questionnaires

> List your questionnaires, newest first, in a limit/offset pagination envelope (`{count, next, previous, results}`, default page size 50). Each row is one version; `questionnaire_group_id` is the stable group ID resolved to the latest `published` version.

export const AgentPromptAccordion = ({prompt, title = "AI Agent Integration Prompt"}) => {
  const [copied, setCopied] = React.useState(false);
  const handleCopy = e => {
    e.stopPropagation();
    if (!prompt) return;
    navigator.clipboard.writeText(prompt.trim()).then(() => {
      setCopied(true);
      setTimeout(() => setCopied(false), 2000);
    });
  };
  const agents = ["Claude Code", "Codex", "Cursor", "Devin", "Windsurf", "GitHub Copilot"];
  return <div className="didit-agent-card">
      {}
      <div className="didit-agent-titlebar">
        <div className="didit-agent-dots" aria-hidden="true">
          <span className="didit-agent-dot didit-agent-dot-red"></span>
          <span className="didit-agent-dot didit-agent-dot-yellow"></span>
          <span className="didit-agent-dot didit-agent-dot-green"></span>
        </div>
        <span className="didit-agent-filename">{title}</span>
        <button type="button" className={`didit-agent-copy ${copied ? "didit-agent-copy-copied" : ""}`} onClick={handleCopy} title="Copy prompt to clipboard" aria-label={copied ? "Copied!" : "Copy prompt to clipboard"}>
          {copied ? <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <path d="M3 8.5l3.5 3.5L13 4" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" />
              </svg>
              <span>Copied</span>
            </> : <>
              <svg width="13" height="13" viewBox="0 0 16 16" fill="none">
                <rect x="5" y="5" width="9" height="9" rx="1.5" stroke="currentColor" strokeWidth="1.5" />
                <path d="M11 5V3.5A1.5 1.5 0 0 0 9.5 2h-6A1.5 1.5 0 0 0 2 3.5v6A1.5 1.5 0 0 0 3.5 11H5" stroke="currentColor" strokeWidth="1.5" />
              </svg>
              <span>Copy</span>
            </>}
        </button>
      </div>

      {}
      <pre className="didit-agent-body"><code>{prompt.trim()}</code></pre>

      {}
      <div className="didit-agent-footer">
        <span className="didit-agent-footer-label">Paste into</span>
        <div className="didit-agent-chips">
          {agents.map(name => <span key={name} className="didit-agent-chip">{name}</span>)}
        </div>
      </div>
    </div>;
};

<AgentPromptAccordion
  title="List Questionnaires API Prompt"
  prompt={`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.`}
/>


## OpenAPI

````yaml GET /v3/questionnaires/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: Identity verification API. Authenticate with x-api-key header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/questionnaires/:
    get:
      tags:
        - Questionnaires
      summary: List questionnaires
      description: >-
        List your questionnaires, newest first, in a limit/offset pagination
        envelope (`{count, next, previous, results}`, default page size 50).
        Each row is one version; `questionnaire_group_id` is the stable group ID
        resolved to the latest `published` version.
      operationId: list_questionnaires
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
          description: Page size (number of questionnaires per page).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
          description: Number of rows to skip before the first returned questionnaire.
      responses:
        '200':
          description: >-
            One page of questionnaires ordered by `created_at` descending,
            wrapped in the pagination envelope. Each item in `results` is a
            `QuestionnaireListItem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: >-
                      Total number of questionnaire versions for the
                      application.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: URL of the next page, or `null` on the last page.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: URL of the previous page, or `null` on the first page.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/QuestionnaireListItem'
              examples:
                One questionnaire:
                  summary: A simple bilingual questionnaire
                  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: >-
            API key missing, malformed, expired, or scoped to a different
            application.
          content:
            application/json:
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: Rate limit exceeded. Retry with exponential backoff.
        '500':
          description: Unexpected server error while building the list. Safe to retry.
      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 (requests)
          source: |-
            import requests

            resp = requests.get(
                "https://verification.didit.me/v3/questionnaires/",
                headers={"x-api-key": "YOUR_API_KEY"},
                timeout=10,
            )
            resp.raise_for_status()
            page = resp.json()
            for q in page["results"]:
                print(q["uuid"], q["title"], q["status"])
        - lang: JavaScript
          label: Node.js (fetch)
          source: >-
            const res = await
            fetch("https://verification.didit.me/v3/questionnaires/", {
              headers: { 'x-api-key': 'YOUR_API_KEY' },
            });

            if (!res.ok) throw new Error(`Didit ${res.status}`);

            const page = await res.json();

            page.results.forEach((q) => console.log(q.uuid, q.title, q.status));
components:
  schemas:
    QuestionnaireListItem:
      type: object
      description: One questionnaire version in the list view.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Per-version UUID. Use as `{questionnaire_uuid}` for
            get/update/delete and as `questionnaire_uuid` in a workflow's
            QUESTIONNAIRE feature config.
        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 for linear questionnaires created through this API; false for
            graph-based questionnaires built in the Console.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        question_types:
          type: array
          items:
            type: string
          description: >-
            Uppercase element types of the answerable questions, in creation
            order (e.g. `SHORT_TEXT`, `MULTIPLE_CHOICE`, `FILE_UPLOAD`).
            Structural `SECTION_HEADER` and `SEPARATOR` elements are excluded.
            One entry per question, so values can repeat.
        workflow_names:
          type: array
          items:
            type: string
          description: >-
            Names of workflows using this questionnaire. Currently always `[]`
            on this endpoint (populated only in the Console listing).
        questionnaire_group_id:
          type: string
          format: uuid
          description: >-
            Stable identifier that groups all versions of the same
            questionnaire.
        version:
          type: integer
          description: Version number within the group, starting at 1.
        status:
          type: string
          enum:
            - draft
            - published
        published_at:
          type: string
          format: date-time
          nullable: true
          description: When this version was published. `null` for drafts.
        is_editable:
          type: boolean
          description: True when this version is a `draft`.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````