GET /components/{name}

Fetch a single custom component's full field definition by name.

Fetch a single custom component's full definition by name, including its field list.

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

Path parameters

Param	Type	Required	Notes
`name`	string	yes	The schema name, e.g. `post`.

Query parameters

Param	Type	Required	Notes
`websiteId`	uuid	yes	Must be a valid UUID.
`api_key`	string	no	Alternative to the `x-api-key` header.

Response

{
  "id": "...",
  "name": "post",
  "displayName": "Post",
  "description": "A documentation Post",
  "category": "Custom",
  "titleField": "title",
  "routeSlugField": "title",
  "icon": null,
  "fields": [
    { "name": "title", "type": "string", "required": true }
  ],
  "slugFields": ["title", "description"],
  "version": 8
}

slugFields is computed — the names of all string-typed fields.

Example

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

Errors

400 — missing or invalid websiteId
401 — invalid API key
404 — schema not found

Previous‹GET /components NextGET /dataset/{schema_name}›