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

> List your workflows, newest first, in a limit/offset pagination envelope (`{count, next, previous, results}`, default page size 50). Each row is one version; `workflow_id` is the stable group ID and new sessions use 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 Workflows API Prompt"
  prompt={`List every Didit workflow in my application through the Management API.

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

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

Goal:
- Retrieve every workflow (verification settings record) defined for the application bound to my API key.
- Use the results to render a workflow picker, sync workflow ids into my config, or discover the workflow_id of a workflow created in the Console.

Behavior:
- Results are returned newest first (ordered by -created_at).
- The endpoint does not paginate today — every workflow record comes back in one response.
- Each row is a single version of a workflow group. workflow_id is the stable identifier shared by every version, version is the integer version number, and status is "draft" or "published".
- The workflow with is_default: true is used whenever a session is created without an explicit workflow_id.
- is_editable: true means the row is a draft and can still be patched via PATCH /v3/workflows/{settings_uuid}/.
- Filter client-side by is_archived and status if you maintain hundreds of workflows.

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

What to do with the response:
- Use settings_uuid as the path id for GET / PATCH / DELETE /v3/workflows/{settings_uuid}/.
- Use workflow_id when creating a session via POST /v3/session/.

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 workflows for this application.
- 429 — rate limited; back off and retry using Retry-After.

Side effects: none. This is a pure read.

For the full integration shape (auth, retries, error handling), see /integration/integration-prompt.`}
/>


## OpenAPI

````yaml GET /v3/workflows/
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/workflows/:
    get:
      tags:
        - Workflows
      summary: List workflows
      description: >-
        List your workflows, newest first, in a limit/offset pagination envelope
        (`{count, next, previous, results}`, default page size 50). Each row is
        one version; `workflow_id` is the stable group ID and new sessions use
        the latest `published` version.
      operationId: list_workflows
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 50
          description: Page size (number of workflows per page).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
          description: Number of rows to skip before the first returned workflow.
      responses:
        '200':
          description: >-
            One page of workflows ordered by `created_at` descending, wrapped in
            the pagination envelope. Each item in `results` is a
            `WorkflowListItem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    description: Total number of workflow 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/WorkflowListItem'
              examples:
                Two workflows:
                  summary: A default KYC workflow and a draft KYC + AML workflow
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: a1b2c3d4-5678-90ab-cdef-111111111111
                        workflow_id: a1b2c3d4-5678-90ab-cdef-111111111111
                        workflow_label: Standard KYC
                        workflow_type: kyc
                        is_default: true
                        is_archived: false
                        is_white_label_enabled: false
                        total_price: 0.15
                        min_price: 0.15
                        max_price: 0.15
                        features: OCR + LIVENESS + FACE_MATCH
                        is_simple_workflow: true
                        is_editable: false
                        workflow_url: https://verify.didit.me/u/_yljPOx8RWG3UAz5ZRQGVQ
                        max_retry_attempts: 3
                        retry_window_days: 7
                        session_expiration_time: 604800
                        version: 2
                        status: published
                        has_draft: false
                        created_by:
                          name: Alex Mateo
                          email: alex@example.com
                          type: user
                        updated_at: '2026-04-12T10:30:00Z'
                      - uuid: b2c3d4e5-6789-01bc-defa-222222222222
                        workflow_id: b2c3d4e5-6789-01bc-defa-222222222222
                        workflow_label: Full Verification + AML
                        workflow_type: kyc
                        is_default: false
                        is_archived: false
                        is_white_label_enabled: false
                        total_price: 0.25
                        min_price: 0.25
                        max_price: 0.25
                        features: OCR + LIVENESS + FACE_MATCH + AML
                        is_simple_workflow: true
                        is_editable: true
                        workflow_url: https://verify.didit.me/u/Aq3kPOx8RWG3UAz5ZRQGVQ
                        max_retry_attempts: 3
                        retry_window_days: 7
                        session_expiration_time: 604800
                        version: 1
                        status: draft
                        has_draft: true
                        created_by: null
                        updated_at: '2026-04-15T18:05:21Z'
        '403':
          description: >-
            The API key is missing, malformed, expired, or belongs to a
            different application. Body: `{"detail": "You do not have permission
            to perform this action."}`. Refresh the token via the [Auth
            API](/auth-api/get-credentials) and retry.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Invalid token:
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: >-
            Rate limit exceeded. Retry with exponential backoff and honour any
            `Retry-After` header.
        '500':
          description: >-
            Unexpected server error while building the list. The request can be
            safely retried.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |-
            curl -X GET 'https://verification.didit.me/v3/workflows/' \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Accept: application/json'
        - lang: Python
          label: Python (requests)
          source: |-
            import requests

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

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

            const page = await res.json();

            page.results.forEach((w) => console.log(w.uuid, w.workflow_label,
            w.status));
components:
  schemas:
    WorkflowListItem:
      type: object
      description: One workflow version in the list view.
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Per-version UUID. Use as `{settings_uuid}` for get/update/delete,
            and as `workflow_id` when creating sessions.
        workflow_id:
          type: string
          format: uuid
          description: >-
            Stable group ID shared by every version of the same workflow. Equals
            `uuid` for version 1.
        workflow_label:
          type: string
          description: Display name for the workflow.
        workflow_type:
          type: string
          nullable: true
          description: >-
            Base type for simple workflows: `kyc`, `kyb`,
            `adaptive_age_verification`, `biometric_authentication`, etc. `null`
            for graph-based workflows without a KYB feature.
        is_default:
          type: boolean
          description: Whether this is the default workflow for new sessions.
        is_archived:
          type: boolean
        is_white_label_enabled:
          type: boolean
          description: >-
            Whether white-label customization applies to sessions created with
            this workflow.
        total_price:
          type: number
          description: >-
            Fixed price per verification in USD (JSON number, excludes
            variable-priced features such as DATABASE_VALIDATION and
            PHONE_VERIFICATION).
        min_price:
          type: number
          description: Cheapest fixed price across workflow-graph paths, in USD.
        max_price:
          type: number
          description: Most expensive fixed price across workflow-graph paths, in USD.
        features:
          type: string
          description: >-
            Enabled features as a single `" + "`-joined string, e.g. `"OCR +
            LIVENESS + FACE_MATCH"`. Split on `" + "` to get a list.
        is_simple_workflow:
          type: boolean
          description: True when the workflow has no custom workflow graph.
        is_editable:
          type: boolean
          description: >-
            True when this version is a `draft` (drafts are editable in place;
            published versions are immutable in the Console).
        workflow_url:
          type: string
          format: uri
          description: >-
            Public shareable verification URL for this workflow
            (`https://verify.didit.me/u/<token>`).
        max_retry_attempts:
          type: integer
          description: Maximum retry attempts allowed after a declined verification (0-10).
        retry_window_days:
          type: integer
          nullable: true
          description: >-
            Rolling window in days used to count retries (1-365). `null` =
            all-time limit.
        session_expiration_time:
          type: integer
          description: Seconds before an unfinished session expires (3600-2419200).
        version:
          type: integer
          description: Version number within the `workflow_id` group, starting at 1.
        status:
          type: string
          enum:
            - draft
            - published
          description: >-
            Version status. New sessions use the latest `published` version of a
            group.
        has_draft:
          type: boolean
          description: >-
            True when any version in this `workflow_id` group is currently a
            draft.
        created_by:
          type: object
          nullable: true
          description: >-
            Who created this version: `{name, email, type}` where `type` is
            `user` (Console user, `email` set) or `api_key` (`name` is the
            client id, `email` is null). `null` when no creator was recorded.
          properties:
            name:
              type: string
            email:
              type: string
              nullable: true
            type:
              type: string
              enum:
                - user
                - api_key
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````