profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with Components구성 요소 유형Setup server sent events (SSE) content refetch어드민 패널 프록시 설정템플릿 빌더에서 스크립팅Project Scaffolding미디어 라이브러리

Headless

Quick startjson과 Claude 코드컴포넌트 Zod 가져오기

REST API

REST API 개요get웹사이트를 CMS API에 연결하기get경로 가져오기get라우트 가져오기get블록 가져오기getCEL 캐시가 포함된 블록 가져오기get블록 생성 가져오기get컴포넌트 가져오기getGET /components/{name}get데이터셋 스키마 이름 가져오기getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}post게시물 번역patch번역 패치get사용량 가져오기postPOST /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": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "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}›