List content pages
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/content-pages?page_type=about&include_seo_metadata=false&filters=%5B%7B%22field%22%3A%22page_type%22%2C%22operator%22%3A%22is%22%2C%22values%22%3A%5B%22faq%22%5D%7D%5D&sort_order=asc';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/content-pages?page_type=about&include_seo_metadata=false&filters=%5B%7B%22field%22%3A%22page_type%22%2C%22operator%22%3A%22is%22%2C%22values%22%3A%5B%22faq%22%5D%7D%5D&sort_order=asc' \ --header 'x-api-key: <x-api-key>'Returns the store’s content pages, newest first by default. Filter by page_type, is_published or search (title, slug and content), sort with sort_by and sort_order, or pass filters for list-view filters. Each response holds at most 10 pages: limit and offset are not accepted, so use the list-all route to read every page.
Required scopes: read:pages
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Only pages of this type
Only published (true) or only draft (false) pages
Search the title, slug and content
Only the page with this ID
Only the page with this slug
Example
trueInclude each page’s search engine metadata as seo_metadata
Signed preview token from the preview link route; lets a draft page be returned
Example
[{"field":"page_type","operator":"is","values":["faq"]}]Admin list-view filters, a JSON array of {field, operator, values}. At most 10 clauses, at most 50 values each.
Field to sort by: id, title, slug, page_type, created_at or updated_at. Defaults to created_at.
Sort direction. Defaults to desc.
Responses
Section titled “Responses”object
object
HTML content of the page. Null when the page has no content.
What kind of page this is.
When the page was deleted. Always null on pages you can read.
Search engine metadata. Present only when include_seo_metadata is passed; null when the page has none.
object
Page title for search engines, or null when none is set.
Page description for search engines, or null when none is set.
Page ID.
Title of the page.
URL slug, unique within the store.
Whether the page is visible on the storefront.
Manual position among the store’s pages.
When the page was created, as an ISO 8601 timestamp.
When the page was last updated, as an ISO 8601 timestamp.
True while the page still holds the unedited text the store was created with.
object
Total number of items matching the request.
Maximum number of items in this page.
Number of items skipped before this page.
Current page number, starting at 1.
Total number of pages.
Whether a next page exists.
Whether a previous page exists.
Example
{ "data": [ { "page_type": "about" } ]}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}