Skip to Content

Page

Describes a page.

Type Definition

type Page { handle: String seoDescription: String seoTitle: String seoKeywords: String title: String id: Int isStatic: Boolean content: String createdAt: String updatedAt: String }

Fields

FieldTypeNullableDescriptionRelated Type
handleStringYesReturns the handle.
seoDescriptionStringYesReturns description for search engines.
seoTitleStringYesReturns title for search engines.
seoKeywordsStringYesReturns keywords for search engines.
titleStringYesReturns the title.
idIntYesReturns the id.
isStaticBooleanYesReturns true if this page was not built with the theme editor and has static content.
contentStringYesReturns the static page content.
createdAtStringYesReturns the date when this page was created.
updatedAtStringYesReturns the date when this page was last updated at.

Relationships

  • The Page object is used by the Link object via the page field, establishing a connection where a link can reference a page.
  • No other direct relationships or connections to other object types are defined on Page.

Usage Examples

Basic Query

{ page(id: 12345) { id title handle seoTitle seoDescription seoKeywords isStatic content createdAt updatedAt } }

Field Selection

{ page(id: 12345) { title handle seoTitle } }

Nested Queries

{ link(id: 67890) { url page { id title content } } }

Filtering and Sorting

The Page object itself does not define filtering, sorting, or pagination fields. These operations should be applied at the query level that returns collections of Page objects, if supported by the API.

Implements

The Page type does not implement any interfaces.

Connections

No connection fields or pagination mechanisms are defined directly on the Page type.

  • Link — references Page via its page field, allowing traversal from a link to its associated page.

Best Practices

  • When querying Page, select only the fields you need to optimize response size and improve performance.
  • Use the id field to uniquely identify pages in queries and mutations.
  • Use isStatic to differentiate between pages created via the theme editor and those with static content.
  • Leverage SEO-related fields (seoTitle, seoDescription, seoKeywords) to enhance search engine optimization in your applications.

Notes

  • All fields on Page are optional and may return null if the data is not available.
  • Dates (createdAt, updatedAt) are returned as ISO 8601 formatted strings.
  • The API currently requires no authentication, but this may change in future versions.
  • There are no computed or derived fields defined on Page.
  • No field arguments are defined for Page fields.
  • For performance, avoid querying large content fields unless necessary, as they may contain substantial static page content.
Last updated on