Choose a version:

article

query

Returns a Article resource by ID.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ArticleArticle

•Article

An article that contains content, author information, and metadata. Articles belong to a Blog and can include HTML-formatted body text, summary text, and an associated image. Merchants publish articles to share content, drive traffic, and engage customers.

Articles can be organized with tags and published immediately or scheduled for future publication using the publishedAt timestamp. The API manages comments on articles when the blog's comment policy enables them.

Anchor to authorauthor

•ArticleAuthor

The name of the author of the article.

Anchor to blogblog

•Blog!

non-null

The blog containing the article.

Anchor to bodybody

•HTML!

non-null

The text of the article's body, complete with HTML markup.

Anchor to commentscomments

•CommentConnection!

non-null

List of the article's comments.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying 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 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 comment was created.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the comment was published.
Anchor to published_status •string: Filter by published status
Anchor to status •string
Anchor to updated_at •time: Filter by the date and time when the comment was last updated.

Anchor to commentsCountcommentsCount

•Count

Count of comments. Limited to a maximum of 10000 by default.

Arguments

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 comment was created.
Anchor to id •id: Filter by id range.
Anchor to published_at •time: Filter by the date and time when the comment was published.
Anchor to published_status •string: Filter by published status
Anchor to status •string
Anchor to updated_at •time: Filter by the date and time when the comment was last updated.

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time (ISO 8601 format) when the article was created.

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 firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

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 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 happened.
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 handlehandle

•String!

non-null

A unique, human-friendly string for the article that's automatically generated from the article's title. The handle is used in the article's URL.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to imageimage

•Image

The image associated with the article.

Anchor to isPublishedisPublished

•Boolean!

non-null

Whether or not the article 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 namespacenamespace •String: The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
Anchor to keykey •String! required: The key for the metafield.

Anchor to metafieldsmetafields

•MetafieldConnection!

non-null

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

Anchor to namespacenamespace •String: The metafield namespace to filter by. If omitted, all metafields are returned.
Anchor to keyskeys •[String!]: List of keys of metafields in the format namespace.key, will be returned in the same format.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to publishedAtpublishedAt

•DateTime

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

Anchor to summarysummary

•HTML

A summary of the article, which can include HTML markup. The summary is used by the online store theme to display the article on other pages, such as the home page or the main blog page.

Anchor to tagstags

•[String!]!

non-null

A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.

Anchor to templateSuffixtemplateSuffix

•String

The name of the template an article is using if it's using an alternate template. If an article is using the default article.liquid template, then the value returned is null.

Anchor to titletitle

•String!

non-null

The title of the article.

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

The date and time (ISO 8601 format) when the article was last updated.

Anchor to metafieldDefinitionsmetafieldDefinitions

•MetafieldDefinitionConnection!

non-nullDeprecated

Arguments

Anchor to namespacenamespace

•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus

•MetafieldDefinitionPinnedStatus

Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

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.

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.

Was this section helpful?

Examples

Receive a single Article

Query

query ArticleShow($id: ID!) {
  article(id: $id) {
    id
    author {
      name
    }
    createdAt
    handle
  }
}

Variables

{
  "id": "gid://shopify/Article/959752435"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ArticleShow($id: ID!) { article(id: $id) { id author { name } createdAt handle } }",
 "variables": {
    "id": "gid://shopify/Article/959752435"
  }
}'

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 ArticleShow($id: ID!) {
    article(id: $id) {
      id
      author {
        name
      }
      createdAt
      handle
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Article/959752435"
    },
  },
  );
  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 ArticleShow($id: ID!) {
    article(id: $id) {
      id
      author {
        name
      }
      createdAt
      handle
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Article/959752435"
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query ArticleShow($id: ID!) {
      article(id: $id) {
        id
        author {
          name
        }
        createdAt
        handle
      }
    }`,
    "variables": {
        "id": "gid://shopify/Article/959752435"
    },
  },
});

Response

{
  "article": {
    "id": "gid://shopify/Article/959752435",
    "author": {
      "name": "dennis"
    },
    "createdAt": "2012-01-01T00:00:00Z",
    "handle": "you-should-buy-this"
  }
}

Receive a single Article

Open in GraphiQL

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

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

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

const response = await admin.graphql(

`#graphql

query ArticleShow($id: ID!) {

article(id: $id) {

author {

name

}

createdAt

handle

}

}`,

{

variables: {

"id": "gid://shopify/Article/959752435"

);

const json = await response.json();

return json.data;

}

GQL

query ArticleShow($id: ID!) {
  article(id: $id) {
    id
    author {
      name
    }
    createdAt
    handle
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query ArticleShow($id: ID!) { article(id: $id) { id author { name } createdAt handle } }",
 "variables": {
    "id": "gid://shopify/Article/959752435"
  }
}'

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 ArticleShow($id: ID!) {
    article(id: $id) {
      id
      author {
        name
      }
      createdAt
      handle
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/Article/959752435"
    },
  },
  );
  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 ArticleShow($id: ID!) {
      article(id: $id) {
        id
        author {
          name
        }
        createdAt
        handle
      }
    }`,
    "variables": {
        "id": "gid://shopify/Article/959752435"
    },
  },
});

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 ArticleShow($id: ID!) {
    article(id: $id) {
      id
      author {
        name
      }
      createdAt
      handle
    }
  }
QUERY

variables = {
  "id": "gid://shopify/Article/959752435"
}

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

Input variables

JSON

{

"id": "gid://shopify/Article/959752435"

}

Response

JSON

{

"article": {

"id": "gid://shopify/Article/959752435",

"author": {

"name": "dennis"

"createdAt": "2012-01-01T00:00:00Z",

"handle": "you-should-buy-this"

}