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

# فئات القائمة

> اقرأ فئات قائمة المطعم مع ترقيم الصفحات والمنتجات الاختيارية.

استخدم فئات القائمة API لعرض التنقل بين الفئات أو الصفحات المقصودة للفئة.

```text theme={null}
GET /api/public/menu/categories
```

تتوقع نقطة النهاية هذه حاليًا وجود مفتاح API في سلسلة الاستعلام.

## مثال

```bash theme={null}
curl "https://api.plato.ae/api/public/menu/categories?apiKey=$PLATO_API_KEY&includeProducts=true"
```

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

| المعلمة           | يكتب          | تقصير       | ملحوظات                                         |
| ----------------- | ------------- | ----------- | ----------------------------------------------- |
| `apiKey`          | خيط           | مطلوب       | مفتاح Plato API.                                |
| `search`          | خيط           | لا أحد      | البحث عن أسماء الفئات.                          |
| `slug`            | خيط           | لا أحد      | جلب فئة واحدة عن طريق سبيكة بالضبط.             |
| `ids`             | قائمة الفاصلة | لا أحد      | جلب معرفات فئة محددة.                           |
| `sortBy`          | خيط           | `createdAt` | `name` أو `createdAt` أو `updatedAt` أو `slug`. |
| `sortOrder`       | خيط           | `desc`      | `asc` أو `desc`.                                |
| `page`            | رقم           | `1`         | رقم الصفحة.                                     |
| `limit`           | رقم           | `20`        | الحد الأدنى `1` والحد الأقصى `100`.             |
| `includeProducts` | منطقية        | `false`     | تضمين المنتجات المنشورة تحت كل فئة.             |

## إجابة

```json theme={null}
{
  "data": [
    {
      "id": "category_123",
      "slug": "burgers",
      "name": {
        "en": "Burgers"
      },
      "description": null,
      "thumbnail": null,
      "smallThumbnail": null,
      "showcase": null,
      "productsCount": 12,
      "products": [
        {
          "id": "product_123",
          "slug": "classic-burger",
          "name": {
            "en": "Classic Burger"
          },
          "priceOptions": [],
          "published": true,
          "soldout": false
        }
      ],
      "createdAt": "2026-06-17T08:20:00.000Z",
      "updatedAt": "2026-06-17T09:15:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 5,
    "totalPages": 1,
    "hasMore": false
  }
}
```

يتم تضمين `products` فقط عند `includeProducts=true`.

## ملحوظات

* المنتجات المضمنة هي منتجات منشورة.
* استخدم `includeProducts=false` لقوائم التنقل.
* استخدم `includeProducts=true` لصفحات الفئات التي تحتاج إلى قائمة المنتجات الأولى على الفور.