pages

A paginated list of pages from the online store. Page objects are content pages that merchants create to provide information to customers, such as "About Us", "Contact", or policy pages.

Use it in a workflow

Add a step and choose the Shopify 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, $savedSearchId: ID) {
  pages(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        body
        bodySummary
        createdAt
        defaultCursor
        handle
        id
        isPublished
        publishedAt
        templateSuffix
        title
        updatedAt
      }
    }
    nodes {
      body
      bodySummary
      createdAt
      defaultCursor
      handle
      id
      isPublished
      publishedAt
      templateSuffix
      title
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofIDPUBLISHED_ATTITLEUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | created_at | time | Filter by the date and time when the page was created. | | | - `created_at:>'2020-10-21T23:39:20Z'` - `created_at:<now` - `created_at:<=2024` | | handle | string | Filter by the handle of the page. | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | published_at | time | Filter by the date and time when the page was published. | | | - `published_at:>'2020-10-21T23:39:20Z'` - `published_at:<now` - `published_at:<=2024` | | published_status | string | Filter by published status | | title | string | Filter by the title of the page. | | updated_at | time | Filter by the date and time when the page was last updated. | | | - `updated_at:>'2020-10-21T23:39:20Z'` - `updated_at:<now` - `updated_at:<=2024` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "ID",
  "query": "string",
  "savedSearchId": "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

defaultCursorobject

handleobject

idobject

isPublishedobject

publishedAtobject

templateSuffixobject

titleobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?