Skip to content

Export CMS Pages

Downloads the CMS pages datagrid as a CSV file — the same data the admin CMS → Pages "Export" button produces. The response is a binary text/csv attachment, not JSON.

Unlike the listing, the export is not paginated — it streams every page that matches the current filters.

REST only

There is no GraphQL counterpart — binary file streams aren't expressible over GraphQL. Use this REST endpoint for the export.

Endpoint

EndpointMethod
/api/admin/cms/pages/exportGET

Request headers

HeaderValue
AuthorizationBearer <token>
Accepttext/csvrequired. The endpoint only produces text/csv; sending Accept: application/json returns 406 Not Acceptable.

Query parameters

ParameterTypeDescription
formatstringExport format — only csv is supported (the default). Any other value returns 422.

The export also accepts the same filters as the listing:

FilterTypeDescription
idintegerFilter by page ID.
page_titlestringPartial title match.
url_keystringPartial url_key match.
channelintegerChannel ID.
localestringLocale code used for translation resolution.

Columns

The CSV carries the five datagrid columns, in order:

HeaderValue
IDPage ID.
Page TitlePage title for the resolved locale.
URL KeyThe storefront URL slug.
ChannelChannel code.
LocaleResolved locale code.

Permission

cms

Released under the MIT License.