Passer au contenu principal
Utilisez des requêtes de liste pour afficher des pages, synchroniser du contenu ou récupérer une petite page d’enregistrements. 
GET /api/public/cms/[modelId]/list

​
Exemple

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

​
Paramètres de requête

ParamètreTaperDéfautRemarques
limitnombre201 minimum, 100 maximum.
offsetnombre0Nombre d’entrées à ignorer.
fieldschaînechamps système et champs visiblesSélectionnez des champs spécifiques.
includeHiddenbooléennefalseIncluez les champs CMS masqués lorsque la clé peut y accéder.
maxDepthnombre3Profondeur d’expansion de la relation. 6 maximale.

​
Sélectionnez les champs

Utilisez fields pour que les réponses soient petites : 
curl "https://api.plato.ae/api/public/cms/products/list?fields=id,name,price,category(id,name)" \
  -H "Authorization: Bearer $PLATO_API_KEY"
Les champs de relation imbriqués utilisent des parenthèses : 
category(id,name)

​
Réponse

Le corps de la réponse est un tableau. 
[
  {
    "id": "entry_123",
    "name": {
      "en": "Classic Burger",
      "ar": "Classic Burger"
    },
    "price": 38,
    "category": {
      "id": "entry_category_1",
      "name": {
        "en": "Burgers"
      }
    }
  }
]
Les métadonnées de pagination sont renvoyées dans les en-têtes : 
x-cms-total: 86
x-cms-limit: 20
x-cms-offset: 0
x-cms-has-more: 1

​
Page suivante

Augmentez offset du nombre de lignes déjà chargées : 
curl "https://api.plato.ae/api/public/cms/products/list?limit=20&offset=20" \
  -H "Authorization: Bearer $PLATO_API_KEY"

​
Remarques

  • Les listes sont limitées à l’espace de travail attaché à la clé API.
  • Les noms de champs inconnus renvoient 400.
  • L’expansion de la relation s’arrête à maxDepth.
  • Pour les pages publiques, sélectionnez uniquement les champs nécessaires sur cette page.