Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)Queriespages

pages

Search and paginate through pages

Authentication

Public Access: Accessible with the public API key

Query Structure

pages(
  first: Int
  after: String
  last: Int
  before: String
  query: String
  sortKey: PageSortKey
  reverse: Boolean
): PageConnection

Arguments

ArgumentTypeRequiredDescription
firstIntNoReturns the first n elements.
afterStringNoReturns elements after cursor.
lastIntNoReturns the last n elements.
beforeStringNoReturns elements before cursor.
queryStringNoSearch query string to filter pages by title or content.
sortKeyPageSortKeyNoThe key to sort pages by.
reverseBooleanNoReverse the order of the underlying list.

Return Type

Returns a PageConnection object containing a paginated list of pages.

Example

query {
  pages(first: 10, query: "about", sortKey: TITLE, reverse: false) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      cursor
      node {
        id
        title
        handle
        body
        createdAt
        updatedAt
      }
    }
  }
}