profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyScripts dans le générateur de modèlesProject ScaffoldingBibliothèque multimédia

Sans interface

Démarrage rapideSplit Screen JSON Component Builder with LLMComponent Zod Pull

API REST

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /components

Répertoriez les résumés des composants personnalisés (schéma de type de contenu) d'un site Web.

Répertoriez les résumés de composants personnalisés (schéma de type de contenu) pour un site Web, classés par nom. Seuls les schémas personnalisés définis par l'utilisateur sont renvoyés.

Auth : Clé API (en-tête x-api-key ou paramètre de requête api_key).

Paramètres de requête

ParamètreTypeObligatoireRemarques
websiteIduuidouiDoit être un UUID valide. Aucun repli Host/config sur ce point de terminaison.
statestringnonFiltrer par état du cycle de vie : draft, active ou archived.
api_keystringnonAlternative à l'en-tête x-api-key.

Réponse

Un tableau JSON de résumés de composants :

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source est toujours "custom". displayName revient à name, et category prend par défaut "Custom" lorsqu'elle n'est pas définie.

Exemple

curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
  -H 'x-api-key: <key>'

Erreurs

  • 400 — websiteId manquant ou invalide
  • 401 — clé API invalide
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›