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 proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Tanpa kepala

Mulai CepatSplit Screen JSON Component Builder with LLMPenarikan Komponen Zod

REST API

ikhtisar API RESTgetConnect 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

Daftar ringkasan komponen kustom (skema jenis konten) milik sebuah situs web.

Daftar ringkasan komponen kustom (skema jenis konten) untuk sebuah situs web, diurutkan berdasarkan nama. Hanya skema kustom yang ditentukan pengguna yang dikembalikan.

Auth: Kunci API (header x-api-key atau parameter kueri api_key).

Parameter kueri

ParameterTipeWajibCatatan
websiteIduuidyaHarus berupa UUID yang valid. Tidak ada fallback Host/konfigurasi pada endpoint ini.
statestringtidakSaring berdasarkan status siklus hidup: draft, active, atau archived.
api_keystringtidakAlternatif untuk header x-api-key.

Respons

Sebuah array JSON berisi ringkasan komponen:

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

source selalu "custom". displayName akan menggunakan name, dan category akan menjadi default ke "Custom" saat tidak ditetapkan.

Contoh

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

Kesalahan

  • 400 — websiteId hilang atau tidak valid
  • 401 — kunci API tidak valid
Continue Reading
Previous‹GET /blocks/generatedNextGET /components/{name}›