Public data API for accessing content, blocks, and data sources
Contact
Servers
List content entries of the space, filtered, sorted, localized, and paginated
List content entries of the space, filtered, sorted, localized, and paginated.
Use vid to select the published or draft version, language plus
include_fallback for localized listings, and parent_id/canonical_parent_id
to fetch the children of a tree node.
Authorizations
API token passed as query parameter
Parameters
Query Parameters
Filter by publication date and time.
">=2024-01-01T00:00:00Z""date-time"Filter by last update date and time.
"2024-01-01T00:00:00Z...2024-01-31T23:59:59Z""date-time"Filter by creation date and time.
"<2024-06-01T00:00:00Z""date-time"Filter by content language ISO code.
"en"Filter by content language ISO code.
"en"Filter by block type slug used by the content entry.
"page"Filter by parent content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical content identifier, including all translations.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical parent identifier, including children of translated parent variants.
"01J123ABC456DEF789GHIJKLMN"Include canonical content without a translation in the requested language.
trueSort by a supported field. Prefix with - for descending order.
"position""-position""published_at""-published_at""updated_at""-updated_at""created_at""-created_at"Responses
Successful response
Get a single content entry by its full slug
Get a single content entry by its full slug. vid selects the published
or draft version; with language set, localized slugs resolve and the
entry is returned in that language with fallback to the canonical values.
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The slug identifier
Responses
Successful response
Search published content entries in the current space
Search published content entries in the current space.
Authorizations
API token passed as query parameter
Parameters
Query Parameters
15001100025Responses
Successful response
List the published tree's slugs and timestamps for sitemap generation,
List the published tree's slugs and timestamps for sitemap generation,
honoring the space's sitemap-extraction settings (which block types are
exposed and where their SEO meta lives).
Authorizations
API token passed as query parameter
Parameters
Query Parameters
Filter by publication date and time.
">=2024-01-01T00:00:00Z""date-time"Filter by last update date and time.
"2024-01-01T00:00:00Z...2024-01-31T23:59:59Z""date-time"Filter by creation date and time.
"<2024-06-01T00:00:00Z""date-time"Filter by content language ISO code.
"en"Filter by content language ISO code.
"en"Filter by block type slug used by the content entry.
"page"Filter by parent content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by content identifier.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical content identifier, including all translations.
"01J123ABC456DEF789GHIJKLMN"Filter by canonical parent identifier, including children of translated parent variants.
"01J123ABC456DEF789GHIJKLMN"Include canonical content without a translation in the requested language.
trueSort by a supported field. Prefix with - for descending order.
"position""-position""published_at""-published_at""updated_at""-updated_at""created_at""-created_at"Responses
Successful response
List the redirect rules of the space as source/target pairs with their
List the redirect rules of the space as source/target pairs with their
HTTP status codes. Frontends typically fetch all pages and build a lookup map.
Authorizations
API token passed as query parameter
Parameters
Query Parameters
Filter by source
Filter by target
Filter by status_code
Free-text search filter.
Sort by field (prefix with - for descending order)
"source""-source""target""-target""status_code""-status_code"Responses
Successful response
Resolve a single redirect by its source path
Resolve a single redirect by its source path. Returns the matching rule
(target and status code) or false when no rule matches. Each hit is
counted in the redirect's usage statistics.
Authorizations
API token passed as query parameter
Request Body
Responses
Successful response
Get the metadata of the token's space, including the current content
Get the metadata of the token's space, including the current content
revision and the enabled languages. Clients use the revision to pin
cache-friendly request URLs.
Authorizations
API token passed as query parameter
Responses
Successful response
List the block definitions of the space, including each block's schema,
List the block definitions of the space, including each block's schema,
type, and tags. Useful for type generation and dynamic rendering.
Authorizations
API token passed as query parameter
Parameters
Query Parameters
Filter by name (LIKE search)
Filter by slug (LIKE search)
Filter by folder ID
Filter by is_nestable
Filter by is_root
Filter by tags
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""slug""-slug""is_nestable""-is_nestable""is_root""-is_root""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
Get a single block definition by ID
Get a single block definition by ID.
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The block identifier
"uuid"Responses
Successful response
List the data sources of the space that are marked as available for the API
List the data sources of the space that are marked as available for the API.
Authorizations
API token passed as query parameter
Parameters
Query Parameters
Filter by name (LIKE search)
Filter by slug (LIKE search)
Filter by external_id
Filter by is_active
Free-text search filter.
Filter by creation date (supports operators and ranges)
Filter by update date (supports operators and ranges)
Sort by field (prefix with - for descending order)
"name""-name""slug""-slug""external_id""-external_id""is_active""-is_active""created_at""-created_at""updated_at""-updated_at"Responses
Successful response
List the entries of a data source, addressed by its slug
List the entries of a data source, addressed by its slug. Supports
dimension selection and pagination; responses honor the source's cache TTL.
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The source identifier
"uuid"Responses
Successful response
List collections
List last modified
List search
Get a single iconify
Render a collection of icons as a single SVG sprite of <symbol> elements
Render a collection of icons as a single SVG sprite of
Each icon becomes a <symbol id="{prefix}--{name}"> that can be referenced
elsewhere with <svg><use href="#{prefix}--{name}"/></svg>. The sprite root
is hidden so it can be inlined at the top of a document without rendering.
Query params:
icons — comma-separated list of icon keys (optional; defaults to all icons)
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The prefix identifier
Responses
Successful response
Render CSS for multiple icons in a single stylesheet
Render CSS for multiple icons in a single stylesheet.
Required: ?icons=name1,name2,...
Query params:
mode — 'mask' (default for currentColor icons) or 'background' (colorful icons)
color — replaces currentColor in the embedded SVG (default: 'black' for mask mode)
selector — per-icon selector template; supports {prefix} and {name} (default: .icon--{prefix}--{name})
common — shared selector for size+mode props (default: .icon--{prefix})
var — CSS variable name for the SVG data URL, without '--' (default: svg → --svg)
flip, rotate — same as SVG endpoint
stroke-width — raw SVG stroke width (viewBox userspace units) for outline icons
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The prefix identifier
Responses
Successful response
Render a single icon as an SVG document
Render a single icon as an SVG document.
Query params:
width — output width (default: 1em)
height — output height (default: 1em)
color — sets CSS color on the SVG root so currentColor inherits it
flip — 'horizontal', 'vertical', or 'horizontal,vertical'
rotate — quarter turns: 1=90°, 2=180°, 3=270°; or '90deg' / '180deg' / '270deg'
box — 1/true adds an invisible bounding
stroke-width — raw SVG stroke width (viewBox userspace units) for outline icons
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The prefix identifier
The name identifier
Responses
Successful response
Render CSS for a single icon
Render CSS for a single icon.
Same query params as iconCss() except icons is not needed.
Authorizations
API token passed as query parameter
Parameters
Path Parameters
The prefix identifier
The name identifier
Responses
Successful response