Skip to content

CMS Pages — List

Paginated CMS-pages list (datagrid parity), returned in the { data, meta } envelope.

TIP

For what CMS Pages are, how multi-locale / multi-channel works, and the previewUrl / htmlContent semantics, see the CMS Pages overview.

Endpoint

EndpointMethod
/api/admin/cms/pagesGET

Query parameters

ParamTypeNotes
pageinteger1-based page number (default 1).
per_pageintegerDefault 10, max 50.
idintegerFilter by page ID.
page_titlestringPartial title match.
url_keystringPartial url_key match.
channelintegerFilter by channel ID.
localestringLocale code used for translation resolution.
sortstringOne of id, page_title, url_key, created_at.
orderstringasc or desc.

Response

200 OK{ data, meta } envelope. Each row carries every cheap column:

FieldTypeNotes
idintegerPage ID.
urlKeystringStorefront URL slug.
pageTitlestringTitle resolved for the active locale.
htmlContentnullDetail-only — always null on the listing; fetch the body from the detail endpoint.
metaTitlestring|nullSEO title.
metaKeywordsstring|nullSEO keywords.
metaDescriptionstring|nullSEO description.
layoutstring|nullPage layout identifier.
previewUrlstringLive storefront URL for the page (the "View" action).
localestringResolved locale code.
channelstringResolved channel code.
channelsstring[]Codes of all channels the page is assigned to.
createdAtstringISO 8601.
updatedAtstringISO 8601.

Released under the MIT License.