> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plato.ae/llms.txt
> Use this file to discover all available pages before exploring further.

# قائمة إدخالات CMS

> جلب قائمة مرقّمة من الإدخالات من قاعدة بيانات CMS.

استخدم طلبات القائمة لعرض الصفحات أو مزامنة المحتوى أو جلب صفحة صغيرة من السجلات.

```text theme={null}
GET /api/public/cms/[modelId]/list
```

## مثال

```bash theme={null}
curl "https://api.plato.ae/api/public/cms/products/list?limit=20&offset=0" \
  -H "Authorization: Bearer $PLATO_API_KEY"
```

## معلمات الاستعلام

| المعلمة         | يكتب   | تقصير                       | ملحوظات                                                         |
| --------------- | ------ | --------------------------- | --------------------------------------------------------------- |
| `limit`         | رقم    | `20`                        | الحد الأدنى `1` والحد الأقصى `100`.                             |
| `offset`        | رقم    | `0`                         | عدد الإدخالات المطلوب تخطيها.                                   |
| `fields`        | خيط    | حقول النظام والحقول المرئية | حدد مجالات محددة.                                               |
| `includeHidden` | منطقية | `false`                     | قم بتضمين حقول CMS المخفية عندما يتمكن المفتاح من الوصول إليها. |
| `maxDepth`      | رقم    | `3`                         | عمق توسيع العلاقة. الحد الأقصى `6`.                             |

## حدد الحقول

استخدم `fields` لإبقاء الردود صغيرة:

```bash theme={null}
curl "https://api.plato.ae/api/public/cms/products/list?fields=id,name,price,category(id,name)" \
  -H "Authorization: Bearer $PLATO_API_KEY"
```

تستخدم حقول العلاقات المتداخلة الأقواس:

```text theme={null}
category(id,name)
```

## إجابة

جسم الاستجابة عبارة عن مصفوفة.

```json theme={null}
[
  {
    "id": "entry_123",
    "name": {
      "en": "Classic Burger",
      "ar": "Classic Burger"
    },
    "price": 38,
    "category": {
      "id": "entry_category_1",
      "name": {
        "en": "Burgers"
      }
    }
  }
]
```

يتم إرجاع البيانات التعريفية للصفحات في الرؤوس:

```text theme={null}
x-cms-total: 86
x-cms-limit: 20
x-cms-offset: 0
x-cms-has-more: 1
```

## الصفحة التالية

قم بزيادة `offset` بعدد الصفوف المحملة بالفعل:

```bash theme={null}
curl "https://api.plato.ae/api/public/cms/products/list?limit=20&offset=20" \
  -H "Authorization: Bearer $PLATO_API_KEY"
```

## ملحوظات

* يتم تحديد نطاق القوائم في مساحة العمل المرفقة بالمفتاح API.
* تُرجع أسماء الحقول غير المعروفة `400`.
* يتوقف توسيع العلاقة عند `maxDepth`.
* بالنسبة للصفحات العامة، حدد فقط الحقول المطلوبة في تلك الصفحة.