Choose a version:

page

query

Returns a Page resource by ID.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the Page to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to PagePage

•Page

A standalone content page in the online store. Pages display HTML-formatted content for informational pages like "About Us", contact information, or shipping policies.

Each page has a unique handle for URL routing and supports custom template suffixes for specialized layouts. Pages can be published or hidden, and include creation and update timestamps.

Anchor to bodybody

•HTML!

non-null

The text content of the page, complete with HTML markup.

Anchor to bodySummarybodySummary

•String!

non-null

The first 150 characters of the page body. If the page body contains more than 150 characters, additional characters are truncated by ellipses.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) of the page creation.

Anchor to defaultCursordefaultCursor

•String!

non-null

A default cursor that returns the single next record, sorted ascending by ID.

Anchor to eventsevents

•EventConnection!

non-null

The paginated list of events associated with the host subject.

Arguments

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 queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to action •string: The action that occured.
Anchor to comments •boolean: Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.
Anchor to created_at •time: Filter by the date and time when the event occurred. Event data is retained for 1 year.
Anchor to id •id: Filter by id range.
Anchor to subject_type •string: The resource type affected by this event. See EventSubjectType for possible values.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•EventSortKeys

Default:ID

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.

Anchor to handlehandle

•String!

non-null

A unique, human-friendly string for the page. In themes, the Liquid templating language refers to a page by its handle.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to isPublishedisPublished

•Boolean!

non-null

Whether or not the page is visible.

Anchor to metafieldmetafield

•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to keykey •String! required: The key for the metafield.
Anchor to namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

A list of custom fields that a merchant associates with a Shopify resource.

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 keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers

•[Metafield]!

non-null

The metafields associated with the resource matching the supplied list of namespaces and keys.

Arguments

Anchor to identifiersidentifiers

•[HasMetafieldsIdentifier!]!

required

The list of metafields to retrieve by namespace and key.

Anchor to publishedAtpublishedAt

•DateTime

The date and time (ISO 8601 format) when the page became or will become visible. Returns null when the page isn't visible.

Anchor to templateSuffixtemplateSuffix

•String

The suffix of the template that's used to render the page.

Anchor to titletitle

•String!

non-null

Title of the page.

Anchor to translationstranslations

•[Translation!]!

non-null

The published translations associated with the resource.

Anchor to localelocale •String! required: Filters translations locale.
Anchor to marketIdmarketId •ID: Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) of the latest page update.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

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 namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time: Filter by the date and time when the metafield definition was created.
Anchor to id •id: Filter by id range.
Anchor to key •string: Filter by the metafield definition key field.
Anchor to namespace •string: Filter by the metafield definition namespace field.
Anchor to owner_type •string: Filter by the metafield definition ownerType field.
Anchor to type •string: Filter by the metafield definition type field.
Anchor to updated_at •time: Filter by the date and time when the metafield definition was last updated.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•MetafieldDefinitionSortKeys

Default:ID

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.

Was this section helpful?

Examples

Retrieves a single page by its ID

Query

query PageShow($id: ID!) {
  page(id: $id) {
    id
    title
    handle
  }
}

Variables

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query PageShow($id: ID!) { page(id: $id) { id title handle } }",
 "variables": {
    "id": "gid://shopify/Page/602767277"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query PageShow($id: ID!) {
    page(id: $id) {
      id
      title
      handle
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Page/602767277"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

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 PageShow($id: ID!) {
    page(id: $id) {
      id
      title
      handle
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query PageShow($id: ID!) {
      page(id: $id) {
        id
        title
        handle
      }
    }`,
    "variables": {
        "id": "gid://shopify/Page/602767277"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query PageShow($id: ID!) {
  page(id: $id) {
    id
    title
    handle
  }
}' \
--variables \
'{
  "id": "gid://shopify/Page/602767277"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query PageShow($id: ID!) {
        page(id: $id) {
          id
          title
          handle
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Page/602767277"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "page": {
    "id": "gid://shopify/Page/602767277",
    "title": "Sample Page",
    "handle": "samplepage"
  }
}

Retrieves a single page by its ID

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

query PageShow($id: ID!) {

page(id: $id) {

title

handle

}

}`,

{

variables: {

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

);

const json = await response.json();

return json.data;

}

GQL

query PageShow($id: ID!) {
  page(id: $id) {
    id
    title
    handle
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query PageShow($id: ID!) { page(id: $id) { id title handle } }",
 "variables": {
    "id": "gid://shopify/Page/602767277"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query PageShow($id: ID!) {
    page(id: $id) {
      id
      title
      handle
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Page/602767277"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query PageShow($id: ID!) {
      page(id: $id) {
        id
        title
        handle
      }
    }`,
    "variables": {
        "id": "gid://shopify/Page/602767277"
    },
  },
});

Ruby

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 PageShow($id: ID!) {
    page(id: $id) {
      id
      title
      handle
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Page/602767277"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'query PageShow($id: ID!) {
  page(id: $id) {
    id
    title
    handle
  }
}' \
--variables \
'{
  "id": "gid://shopify/Page/602767277"
}'

Direct API Access

const response = await fetch('shopify:admin/api/unstable/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query PageShow($id: ID!) {
        page(id: $id) {
          id
          title
          handle
        }
      }
    `,
    variables: {
        "id": "gid://shopify/Page/602767277"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

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

}

Response

JSON

{

"page": {

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

"title": "Sample Page",

"handle": "samplepage"

}