pages

Returns a paginated list of the shop's content pages. Pages are custom HTML content like "About Us", "Contact", or policy information that merchants display outside their product catalog.

Use it in a workflow

Add a step and choose the Shopify Storefront connector.
Pick the pages action (under Pages).
Fill in the fields below, then reference the result from later steps as {{pages.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Pages($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: PageSortKeys, $query: String) {
  pages(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        body
        bodySummary
        createdAt
        handle
        id
        onlineStoreUrl
        seo
        title
        trackingParameters
        updatedAt
      }
    }
    nodes {
      body
      bodySummary
      createdAt
      handle
      id
      onlineStoreUrl
      seo {
        description
        title
      }
      title
      trackingParameters
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

Returns up to the first `n` elements from the list.

afterstring

Returns the elements that come after the specified cursor.

lastnumber

Returns up to the last `n` elements from the list.

beforestring

Returns the elements that come before the specified cursor.

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list by the given key.

One ofTITLEUPDATED_ATIDRELEVANCE

querystring

Apply one or multiple filters to the query. | name | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | | created_at | | handle | | title | | updated_at | Refer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "TITLE",
  "query": "string"
}

Response

Read the result with {{pages.response.data.data.pages}}. If the API returns errors, the step fails and they are at {{pages.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

bodyobject

bodySummaryobject

createdAtobject

handleobject

idobject

onlineStoreUrlobject

seoobject

titleobject

trackingParametersobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify Storefront guide for connection setup and behaviour shared by every action.

Was this page helpful?