pages

query

List of the shop's pages.

PageConnection arguments

•PageConnection!

Anchor to afterafter • String: The elements that come after the specified cursor.
Anchor to beforebefore • String: The elements that come before the specified cursor.
Anchor to firstfirst • Int: The first n elements from the paginated list.
Anchor to lastlast • Int: The last n elements from the paginated list.
Anchor to reversereverse • BooleanDefault:false: Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [PageEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [Page!]!non-null: A list of nodes that are contained in PageEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Retrieves a list of pages

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query PageList {

pages(first: 10) {

edges {

node {

}

pageInfo {

endCursor

hasNextPage

hasPreviousPage

startCursor

}

}`,

);

const data = await response.json();

query PageList {
  pages(first: 10) {
    edges {
      node {
        id
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query PageList { pages(first: 10) { edges { node { id } } pageInfo { endCursor hasNextPage hasPreviousPage startCursor } } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query PageList {
    pages(first: 10) {
      edges {
        node {
          id
        }
      }
      pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query PageList {
    pages(first: 10) {
      edges {
        node {
          id
        }
      }
      pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
      }
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query PageList {
    pages(first: 10) {
      edges {
        node {
          id
        }
      }
      pageInfo {
        endCursor
        hasNextPage
        hasPreviousPage
        startCursor
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"pages": {

"edges": [

{

"node": {

"id": "gid://shopify/Page/602767277"

}

{

"node": {

"id": "gid://shopify/Page/905192165"

}

"pageInfo": {

"endCursor": "eyJsYXN0X2lkIjo5MDUxOTIxNjUsImxhc3RfdmFsdWUiOiI5MDUxOTIxNjUifQ==",

"hasNextPage": false,

"hasPreviousPage": false,

"startCursor": "eyJsYXN0X2lkIjo2MDI3NjcyNzcsImxhc3RfdmFsdWUiOiI2MDI3NjcyNzcifQ=="

}