profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchएडमिन पैनल प्रॉक्सी सेटअपटेम्पलेट बिल्डर में स्क्रिप्टिंगProject Scaffoldingमीडिया लाइब्रेरी

Headless

त्वरित प्रारंभSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetरूट्स प्राप्त करेंgetरूट प्राप्त करेंgetब्लॉक प्राप्त करेंgetCEL कैश के साथ ब्लॉक्स प्राप्त करेंgetब्लॉक्स-जनरेटेड-प्राप्त करेंgetघटक प्राप्त करेंgetGET /components/{name}getडेटासेट स्कीमा नाम प्राप्त करेंgetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchपैच अनुवादgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

घटक प्राप्त करें

किसी वेबसाइट के कस्टम कंपोनेंट (कंटेंट-टाइप स्कीमा) सारांशों की सूची।

किसी वेबसाइट के कस्टम-कंपोनेंट (कंटेंट-टाइप स्कीमा) सारांशों को नाम के अनुसार क्रमबद्ध रूप में सूचीबद्ध करें। केवल उपयोगकर्ता-परिभाषित कस्टम स्कीमा लौटाए जाते हैं।

प्रमाणीकरण: API कुंजी (x-api-key हेडर या api_key क्वेरी पैराम)।

क्वेरी पैरामीटर

पैरामप्रकारआवश्यकटिप्पणियाँ
websiteIduuidहाँएक वैध UUID होना चाहिए। इस एंडपॉइंट पर Host/कॉन्फ़िग फॉलबैक नहीं है।
statestringनहींलाइफ़-साइकल स्थिति के आधार पर फ़िल्टर करें: draft, active या archived।
api_keystringनहींx-api-key हेडर का विकल्प।

प्रतिक्रिया

कंपोनेंट सारांशों का एक JSON ऐरे:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "पोस्ट",
    "description": "एक दस्तावेज़ीकरण पोस्ट",
    "category": "कस्टम",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source हमेशा "custom" होता है। displayName सेट न होने पर name पर वापस चला जाता है, और category सेट न होने पर डिफ़ॉल्ट रूप से "Custom" होता है।

उदाहरण

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

त्रुटियाँ

  • 400 — websiteId गुम या अमान्य
  • 401 — अमान्य API कुंजी
Continue Reading
Previous‹ब्लॉक्स-जनरेटेड-प्राप्त करेंNextGET /components/{name}›