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

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

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

List a website's custom component (content-type schema) summaries.

List custom-component (content-type schema) summaries for a website, ordered by name. Only user-defined custom schemas are returned.

Auth: API key (x-api-key header or api_key query param).

Query parameters

ParamTypeRequiredNotes
websiteIduuidyesMust be a valid UUID. No Host/config fallback on this endpoint.
statestringnoFilter by lifecycle state: draft, active, or archived.
api_keystringnoAlternative to the x-api-key header.

Response

A JSON array of component summaries:

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

source is always "custom". displayName falls back to name, and category defaults to "Custom", when unset.

Example

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

Errors

  • 400 β€” missing or invalid websiteId
  • 401 β€” invalid API key
Continue Reading
Previousβ€ΉGET /blocks/generatedNextGET /components/{name}β€Ί