> For the complete Lynkow documentation index in agent-friendly format, see [llms.txt](/llms.txt). # SDK Types: Pages **Publié le** : 2026-08-20 **Catégorie** : Types # SDK Types: Pages > **Related services:** **PagesService** — `lynkow.pages.getByPath()`, `lynkow.pages.getBySlug()`, `lynkow.pages.getJsonLd()`, `lynkow.pages.list()` | **BlocksService** — `lynkow.blocks.getBySlug()`, `lynkow.blocks.global()`, `lynkow.blocks.siteConfig()` ## `Alternate` *Interface* An alternate language version of the same page. Used to build `` tags for multi-language SEO and language switcher UI components. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `current` | `boolean` | No | Whether this alternate represents the currently requested locale.
Exactly one alternate in the array will have `current: true`.
Useful for highlighting the active language in a language switcher. | | `locale` | `string` | No | BCP 47 locale code of this version (e.g. `'en'`, `'fr'`, `'de'`).
Matches one of the site's enabled locales. | | `path` | `string` | No | URL path to this locale's version of the page (e.g. `'/fr/about'`).
Does **not** include the domain — prepend your site's base URL.
`null` is never returned here; every alternate has a valid path. | --- ## `GlobalBlock` *Interface* A global block (reusable site-wide data object). Global blocks are schema-driven data containers used for site-wide elements like headers, footers, navigation menus, and banners. Their data is defined via a schema in the admin dashboard and can include DataSource references that are resolved server-side before delivery. Global blocks are typically fetched once at app initialization via `site.getConfig()` (which returns all globals) or individually via `blocks.getBySlug()`. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `_warnings` | `string[]` | Yes | Warnings generated during DataSource resolution.
Present only when one or more DataSources failed to resolve
(e.g. referenced content was deleted, DataSource query timed out).
When absent or empty, all data resolved successfully.
Each string describes the specific resolution failure. | | `data` | `Record` | No | Resolved block data.
Structure depends on the block's schema definition in the admin dashboard.
DataSource references are resolved server-side, so this object contains
actual data (e.g. arrays of content summaries, navigation links) rather
than DataSource identifiers.

Richtext fields within the data are automatically converted to HTML strings. | | `name` | `string` | No | Human-readable display name of the block, as set in the admin dashboard.
For UI/debugging purposes; use slug for lookups. | | `slug` | `string` | No | URL-friendly identifier for the block.
Unique within the site. Used to fetch individual blocks via `blocks.getBySlug()`.
Also used as the key in the `globals` map returned by `site.getConfig()`. | --- ## `LegalDocument` *Interface* A legal document (privacy policy, terms of service, cookie policy, etc.). Legal documents are implemented as pages tagged with `'legal'` in the CMS. They use the same schema-driven data model as regular pages but are surfaced through the dedicated `legal` service for convenience. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `data` | `Record` | No | Document content resolved from the page's schema.
Structure depends on how the page's schema was configured in the admin.
Richtext fields are automatically converted to HTML strings.
Typically contains a `'content'` or `'body'` key with the legal text as HTML. | | `id` | `string` | No | Unique identifier for the document.
Format varies by implementation (numeric string or UUID). | | `locale` | `string` | No | Locale code of this document version (e.g. `'en'`, `'fr'`).
Each locale has its own version of the legal document. | | `name` | `string` | No | Display name of the document (e.g. `'Privacy Policy'`, `'Terms of Service'`).
Localized -- changes based on the requested locale. | | `seo` | `{ description?: string \| null; ogImage?: string \| null; title?: string \| null } \| null` | Yes | SEO metadata for the document.
`null` when no SEO settings have been configured for this page. | | `slug` | `string` | No | URL-friendly slug used to fetch the document via `legal.getBySlug()`.
Typically descriptive: `'privacy-policy'`, `'terms-of-service'`, `'cookie-policy'`.
Unique within the site for a given locale. | | `updatedAt` | `string` | No | ISO 8601 datetime string of the last update.
Important for legal compliance -- display this to indicate when the document
was last revised (e.g. "Last updated: March 15, 2025"). | --- ## `Page` *Interface* Full page with resolved data sources, SEO settings, and locale alternates. Returned by single-page endpoints (`GET /storefront/pages/:idOrSlug`). Pages are layout-driven containers whose content comes from **DataSources** — configurable queries that fetch content, categories, forms, or other data. The API resolves all DataSources server-side and returns the results in `data`. Extends: `PageSummary` | Property | Type | Optional | Description | | --- | --- | --- | --- | | `_warnings` | `string[]` | Yes | Warnings emitted during DataSource resolution.
Present only when one or more DataSources encountered non-fatal errors
(e.g. a referenced content was deleted, a query returned no results unexpectedly).
`undefined` when all DataSources resolved successfully.

These are informational — the page still renders, but some `data` keys may
contain empty arrays or `null` instead of the expected content.
Useful for debugging during development; avoid displaying these to end users. | | `alternates` | `Alternate[]` | No | Alternate language versions of this page.
Empty array if the site has only one locale or no translations exist.
Always includes the current locale (with `current: true`).
Use these to build `` tags
and language switcher navigation. | | `data` | `Record` | No | Resolved data from all configured DataSources, keyed by the DataSource name.

Each key corresponds to a DataSource defined in the page's schema.
The value type depends on the DataSource type:
- Content list: array of ContentSummary objects
- Single content: a Content object
- Category list: array of Category objects
- Form: a Form object
- Custom data: any JSON value | | `id` | `number` | No | Unique numeric page ID. Auto-incremented.
Use this for API calls like `GET /storefront/pages/:id`. | | `locale` | `string` | No | BCP 47 locale code of this page (e.g. `'en'`, `'fr'`).
Matches one of the site's enabled locales. | | `name` | `string` | No | Internal page name used for identification in the admin dashboard.
May differ from the SEO title. Max 255 characters. | | `path` | `string \| null` | No | URL path for this page, including locale prefix when applicable.
Format: `'/about'` (mono-language) or `'/en/about'` (multi-language).
`null` if the page has no path set (e.g. a page used only as a data container).
Does **not** include the domain — prepend your site's base URL. | | `seo` | `PageSeo \| null` | No | Page-level SEO settings for meta tags, Open Graph, and Twitter Card.
`null` if no SEO settings are configured for this page. | | `slug` | `string` | No | URL-friendly slug, unique within the site for this locale.
Lowercase, hyphenated (e.g. `'about-us'`). Max 255 characters.
Can be used instead of `id` in API calls: `GET /storefront/pages/:slug`. | | `structuredData` | `{ graph: object[] }` | Yes | Resolved JSON-LD cascade for the page. Server-merged and ready to
render; no client-side cascade logic required.

`undefined` on responses from older API versions that do not populate
the cascade; in that case, fall back to the dedicated
`/storefront/:siteId/pages/:slug/json-ld` endpoint which always returns
the array directly under `data`. | | `updatedAt` | `string \| null` | No | ISO 8601 datetime of the last modification (e.g. `'2024-06-01T14:00:00.000+00:00'`).
Updated whenever the page content, data sources, or SEO settings are saved.
`null` if the page has never been modified after creation (rare edge case). | --- ## `PageSeo` *Interface* SEO settings for a page, controlling meta tags, Open Graph, Twitter Card, and technical SEO directives. All fields are optional — unset fields mean "use the default" or "don't render this tag". The frontend is responsible for rendering these values into the appropriate `` tags. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `canonicalUrl` | `string` | Yes | Override canonical URL for this page. Absolute URL.
`undefined` means the page's own URL is canonical.
Use when the same content is accessible at multiple URLs to avoid duplicate content penalties. | | `keywords` | `string[]` | Yes | Array of keyword strings for ``.
`undefined` means no keywords are set.
Note: most search engines no longer use this for ranking. | | `metaDescription` | `string` | Yes | `` value.
`undefined` means no meta description is set.
Recommended length: 150-160 characters for optimal search engine display. | | `metaTitle` | `string` | Yes | Custom `` and `<meta property="og:title">` value.<br>`undefined` means use the page name as fallback.<br>Recommended length: 50-60 characters for optimal search engine display. | | `noIndex` | `boolean` | Yes | When `true`, adds `<meta name="robots" content="noindex">` to prevent search engine indexing.<br>`undefined` or `false` means the page is indexable.<br>Use for staging pages, internal tools, or pages that should not appear in search results. | | `ogDescription` | `string` | Yes | `<meta property="og:description">` value.<br>`undefined` means fall back to `metaDescription`. | | `ogImage` | `SeoImage \| null` | Yes | Image for Open Graph sharing previews.<br>`null` means explicitly no image; `undefined` means not configured.<br>Recommended size: 1200x630px. | | `ogSiteName` | `string` | Yes | `<meta property="og:site_name">` value.<br>`undefined` means use the site's name from site settings. | | `ogTitle` | `string` | Yes | `<meta property="og:title">` value.<br>`undefined` means fall back to `metaTitle`, then the page name. | | `ogUrl` | `string` | Yes | `<meta property="og:url">` value. Absolute URL.<br>`undefined` means use the canonical URL or the page's own URL. | | `twitterCard` | `"summary" \| "summary_large_image" \| "app" \| "player"` | Yes | `<meta name="twitter:card">` value controlling the Twitter Card layout:<br>- `'summary'`: small square image with title and description<br>- `'summary_large_image'`: large banner image above title and description<br>- `'app'`: app install card (rarely used for websites)<br>- `'player'`: embedded media player<br><br>`undefined` defaults to `'summary_large_image'` if an image is present. | | `twitterDescription` | `string` | Yes | `<meta name="twitter:description">` value.<br>`undefined` means fall back to `ogDescription`, then `metaDescription`. | | `twitterImage` | `SeoImage \| null` | Yes | Image for Twitter Card previews.<br>`null` means explicitly no image; `undefined` means fall back to `ogImage`.<br>Recommended size: 1200x628px for `summary_large_image`, 144x144px for `summary`. | | `twitterTitle` | `string` | Yes | `<meta name="twitter:title">` value.<br>`undefined` means fall back to `ogTitle`, then `metaTitle`, then the page name. | --- ## `PageSummary` *Interface* Lightweight page representation returned in list endpoints. Contains basic identification and routing information. Use Page (from `GET /storefront/pages/:idOrSlug`) for the full page including resolved data, SEO settings, and alternates. | Property | Type | Optional | Description | | --- | --- | --- | --- | | `id` | `number` | No | Unique numeric page ID. Auto-incremented.<br>Use this for API calls like `GET /storefront/pages/:id`. | | `locale` | `string` | No | BCP 47 locale code of this page (e.g. `'en'`, `'fr'`).<br>Matches one of the site's enabled locales. | | `name` | `string` | No | Internal page name used for identification in the admin dashboard.<br>May differ from the SEO title. Max 255 characters. | | `path` | `string \| null` | No | URL path for this page, including locale prefix when applicable.<br>Format: `'/about'` (mono-language) or `'/en/about'` (multi-language).<br>`null` if the page has no path set (e.g. a page used only as a data container).<br>Does **not** include the domain — prepend your site's base URL. | | `slug` | `string` | No | URL-friendly slug, unique within the site for this locale.<br>Lowercase, hyphenated (e.g. `'about-us'`). Max 255 characters.<br>Can be used instead of `id` in API calls: `GET /storefront/pages/:slug`. | | `updatedAt` | `string \| null` | No | ISO 8601 datetime of the last modification (e.g. `'2024-06-01T14:00:00.000+00:00'`).<br>Updated whenever the page content, data sources, or SEO settings are saved.<br>`null` if the page has never been modified after creation (rare edge case). |