> ## 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. # استرجاع القائمة: واجهة Get List لقوائم الامتثال > استرجع تفاصيل قائمة Didit المحددة، سواء كانت قائمة حظر أو سماح أو مخصصة، مع عدد الإدخالات وبياناتها الوصفية عبر GET /v3/lists/{list_uuid}/. مطالبة API للحصول على القائمة نسخ الموجّه إلى الحافظة \

\`Fetch a single Didit list's metadata through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: read.

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

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

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: read.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "No List matches the given query." }).
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

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

\
الصق في احصل على تفاصيل قائمة واحدة، بما في ذلك عدد عناصرها وتاريخ إضافة أحدث عنصر فيها. تُرجع القائمة التابعة لتطبيق آخر، أو القائمة التي تم حذفها، الاستجابة `404`.لقراءة القيم الموجودة في القائمة، استخدم [إدخالات القائمة](https://docs.didit.me/ar/management-api/lists/list-entries.md). ## OpenAPI ````yaml ar/openapi-25.json GET /v3/lists/{list_uuid}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API التحقق من الهوية. قم بالمصادقة باستخدام الرأس x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/{list_uuid}/: get: tags: - Lists summary: الحصول على قائمة description: >- يُرجع قائمة واحدة خاصة بالتطبيق مع عدد الإدخالات فيها ووقت إضافة أحدث إدخال لها. عند طلب قائمة تابعة لتطبيق آخر، أو قائمة محذوفة، يتم إرجاع `404`. يُرجع هذا الـ endpoint القائمة فقط: لقراءة قيمها، استخدم [عرض إدخالات القائمة](https://docs.didit.me/ar/management-api/lists/list-entries). يحتاج مفتاح API ذو نطاق محدد إلى `workflows: read`. operationId: get_list parameters: - name: list_uuid in: path required: true description: معرّف UUID للقائمة، كما تم إرجاعه بواسطة سرد القوائم أو إنشاء قائمة. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 responses: '200': description: القائمة. content: application/json: schema: $ref: '#/components/schemas/ComplianceList' examples: System face blocklist: value: uuid: 11111111-2222-3333-4444-555555555555 name: Face Blocklist description: >- Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined. list_type: blocklist entry_type: face is_system: true entry_count: 12 last_entry_added_at: '2026-10-09T16:42:03.118204Z' created_at: '2026-01-14T10:02:11.402917Z' updated_at: '2026-01-14T10:02:11.402917Z' '401': description: >- انتهت صلاحية مفتاح API محدد النطاق. تُرجع حالات فشل المصادقة الأخرى الرمز `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- رأس `x-api-key` مفقود (المفتاح الخاطئ أو الملغى أو منتهي الصلاحية يحصل على `401`)، أو أن مفتاح API محدد النطاق يفتقر إلى `workflows: read` أو تم استخدامه من عنوان IP خارج قائمة السماح الخاصة به. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no read access to workflows. '404': description: >- لا توجد قائمة بهذا المعرّف UUID في التطبيق المرتبط بمفتاح API، أو قد تم حذفها. content: application/json: examples: Not found: value: detail: No List matches the given query. '429': description: >- تم تجاوز حد القراءة المشترك البالغ 600 طلب في الدقيقة لكل مفتاح API. التزم بالمدة المحددة في `Retry-After` قبل إعادة المحاولة. content: application/json: examples: Rate limited: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.retrieve( "11111111-2222-3333-4444-555555555555", ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.lists.retrieve("11111111-2222-3333-4444-555555555555"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().retrieve("11111111-2222-3333-4444-555555555555"); System.out.println(result); - lang: php label: PHP source: >- lists->retrieve('11111111-2222-3333-4444-555555555555'); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.retrieve("11111111-2222-3333-4444-555555555555") puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ComplianceList: type: object description: قائمة حظر، أو قائمة سماح، أو قائمة مخصصة لتطبيق واحد. required: - uuid - name - description - list_type - entry_type - is_system - entry_count - last_entry_added_at - created_at - updated_at properties: uuid: type: string format: uuid description: >- معرّف القائمة. استخدمه كـ `list_uuid` في endpoints الخاصة بالقوائم والمدخلات، وكقيمة لشرط قاعدة سير عمل أو قاعدة معاملة مع `value_type: "list"`. name: type: string maxLength: 255 description: اسم القائمة، وهو فريد بين قوائم التطبيق. description: type: string description: وصف بنص حر. سلسلة فارغة عند عدم التعيين. list_type: type: string enum: - blocklist - allowlist - custom description: >- `blocklist`: يؤدي التطابق إلى رفض الجلسة أو المعاملة (قوائم النظام فقط، واحدة لكل نوع إدخال). `allowlist`: العناصر المتطابقة تكون موثوقة، على سبيل المثال تتخطى قائمة السماح للوجوه إجراء الوجه المكرر؛ ولا تتجاوز أبدًا تطابق قائمة الحظر. `custom`: تُستخدم في شروط قواعد سير العمل والمعاملات (`value_type: "list"`). entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- ما تحتويه القائمة: `face`، أو `document` (رقم المستند)، أو `phone`، أو `email`، أو `ip_address` (عنوان IP أو نطاق CIDR)، أو `device_fingerprint`، أو `wallet_address`، أو `bank_account`، أو `country` (وفق معيار ISO 3166-1 alpha-3)، أو `user` أو `business` (الخاص بـ `vendor_data` لديك)، أو `key` (أي سلسلة نصية). وتحدد هذه القيمة كيفية التحقق من صحة قيم الإدخال ومطابقتها. is_system: type: boolean description: >- تكون القيمة `true` للقوائم التي توفرها Didit: قائمة حظر واحدة لكل نوع إدخال (`face`، و`document`، و`phone`، و`email`، و`ip_address`، و`device_fingerprint`، و`wallet_address`، و`bank_account`، و`user`، و`business`)، والقائمة المخصصة **High Risk Countries**، وقوائم السماح الخاصة بالنظام. لا يمكن إعادة تسمية قوائم النظام أو تعديلها أو حذفها؛ ولكن يمكنك إضافة مدخلاتها وحذفها. entry_count: type: integer minimum: 0 description: عدد الإدخالات الموجودة حالياً في القائمة. last_entry_added_at: type: string format: date-time nullable: true description: متى أُضيف أحدث مدخل حالي. وتكون `null` للقائمة الفارغة. created_at: type: string format: date-time description: متى تم إنشاء القائمة. updated_at: type: string format: date-time description: متى تم تحديث القائمة آخر مرة. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.