Skip to main content
Anchor to articles

articles

query

List of the shop's articles.

Anchor to Arguments

ArticleConnection arguments

•ArticleConnection!
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 default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=handle:summer-collection-announcement
Anchor to author
•string

Filter by the author of the article.

Anchor to blog_id
•string

Filter by the ID of the blog the article belongs to.

Example:

  • blog_id:1234
  • blog_id:>=1234
  • blog_id:<=1234
Anchor to blog_title
•string
Anchor to created_at
•time

Filter by the date and time when the article was created.

Example:

  • created_at:>'2020-10-21T23:39:20Z'
  • created_at:<now
  • created_at:<=2024
Anchor to handle
•string

Filter by the article's handle.

Example:

  • handle:summer-collection-announcement
  • handle:how-to-guide
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to published_at
•time

Filter by the date and time when the article was published.

Example:

  • published_at:>'2020-10-21T23:39:20Z'
  • published_at:<now
  • published_at:<=2024
Anchor to published_status
•string

Filter by published status

Anchor to tag
•string

Filter objects by the tag field.

Example:

  • tag:my_tag
Anchor to tag_not
•string

Filter by objects that don’t have the specified tag.

Example:

  • tag_not:my_tag
Anchor to title
•string

Filter by the title of the article.

Example:

  • title:summer-collection
  • title:green hoodie
Anchor to updated_at
•time

Filter by the date and time when the article was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'
  • updated_at:<now
  • updated_at:<=2024
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ArticleSortKeys
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?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[ArticleEdge!]!
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
•[Article!]!
non-null

A list of nodes that are contained in ArticleEdge. 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?