> ## 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 All Lists

> GET /v3/lists/ — retrieve all blocklists, allowlists, and custom lists for your app. Filter by list type or entry type. Pay-per-call, no contracts.

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 Lists API Prompt"
  prompt={`Retrieve every blocklist, allowlist, and custom list in my Didit application through the Management API.

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

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

Goal:
- Get a paginated list of all lists for my application so I can find a specific list's uuid, filter by type, or render a picker.

Query parameters (all optional):
- list_type — "blocklist" | "allowlist" | "custom".
- entry_type — face, document, phone, email, ip_address, device_fingerprint, wallet_address, bank_account, user, business, country, key.
- ordering — created_at, -created_at, entry_count, -entry_count, last_entry_added_at, -last_entry_added_at.
- offset — pagination offset (default 0).
- limit — page size (default 25).

Example call:
curl -X GET "https://verification.didit.me/v3/lists/?list_type=blocklist" \\
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
- count / next / previous — standard pagination envelope.
- results[].uuid — list id; use as path id in subsequent list/entry calls.
- results[].is_system — true for the 10 system blocklists (one per entry type). System lists cannot be deleted or renamed.
- results[].entry_count, last_entry_added_at — useful for dashboards.

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

Side effects: none. This is a pure read.

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

Retrieve a paginated list of all lists (blocklists, allowlists, custom) for your application. Filter by `list_type` or `entry_type`.

## Query parameters

| Parameter    | Type    | Description                                                                                                                                                            |
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `list_type`  | string  | Filter by type: `blocklist`, `allowlist`, or `custom`                                                                                                                  |
| `entry_type` | string  | Filter by entry type: `face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `country`, `user`, `business`, `key` |
| `ordering`   | string  | Sort by: `created_at`, `-created_at`, `entry_count`, `-entry_count`, `last_entry_added_at`, `-last_entry_added_at`                                                     |
| `offset`     | integer | Pagination offset (default: 0)                                                                                                                                         |
| `limit`      | integer | Page size (default: 25)                                                                                                                                                |

<RequestExample>
  ```bash theme={null}
  curl -X GET "https://verification.didit.me/v3/lists/?list_type=blocklist" \
    -H "x-api-key: YOUR_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "count": 10,
    "next": null,
    "previous": null,
    "results": [
      {
        "uuid": "a1b2c3d4-...",
        "name": "Face Blocklist",
        "description": "Blocked biometric faces...",
        "list_type": "blocklist",
        "entry_type": "face",
        "is_system": true,
        "entry_count": 3,
        "last_entry_added_at": "2025-06-09T12:26:54Z",
        "created_at": "2025-01-01T00:00:00Z",
        "updated_at": "2025-06-09T12:26:54Z"
      }
    ]
  }
  ```
</ResponseExample>