/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Component Catalogue

Get Component Catalogue

Every MDX component and prop, every frontmatter key and every icon name — the catalogue the compiler checks pages against

GET/v1/schema/components.jsonTry it

Returns the catalogue the compiler uses to check pages: every MDX component with its props and allowed values, every page frontmatter key, and every icon name. Editors and tools can use it to offer completion and catch typos without guessing — it is the same data stx check and the hosted build validate against.

Authentication

None. Public, with the same caching headers as Get syntext.json Schema (Content-Type: application/json).

Response

NameDescription
version:number
The catalogue format version (1).
components:object[]
One entry per component.
Show 12 child attributesobject[]
frontmatter:object[]
One entry per page frontmatter key: { key, type, values?, required?, description, protocol?, note?, deprecated? }. type is string, number, boolean, enum, string[], object, href or icon. protocol names the protocol value an API key is read under (rest, websocket, graphql, grpc, event); deprecated names the replacement key.
icons:string[]
Every icon name a component's icon prop or the icon frontmatter key accepts.
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl --request GET \
--url 'https://api.syntext.dev/v1/schema/components.json'
Responseapplication/json
200OK
{
"version": 0,
"components": [
{
"name": "string",
"category": "string",
"summary": "string",
"description": "string",
"props": [],
"children": [],
"parent": "string",
"inline": true,
"snippet": "string",
"insertable": true,
"note": "string",
"deprecated": "string"
}
],
"frontmatter": [],
"icons": []
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext