Liste des entrées CMS

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ètre	Taper	Défaut	Remarques
`limit`	nombre	`20`	`1` minimum, `100` maximum.
`offset`	nombre	`0`	Nombre d’entrées à ignorer.
`fields`	chaîne	champs système et champs visibles	Sélectionnez des champs spécifiques.
`includeHidden`	booléenne	`false`	Incluez les champs CMS masqués lorsque la clé peut y accéder.
`maxDepth`	nombre	`3`	Profondeur 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.

Commencer

CMS

Connect360

Restaurant

Formulaires

Liste des entrées CMS

Exemple

Paramètres de requête

Sélectionnez les champs

Réponse

Page suivante

Remarques

​Exemple

​Paramètres de requête

​Sélectionnez les champs

​Réponse

​Page suivante

​Remarques

Exemple

Paramètres de requête

Sélectionnez les champs

Réponse

Page suivante

Remarques