The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Article
content
access scope.The Article resource allows your app to create, publish, and edit articles on a shop's blog. Articles belong to a single blog, and can have any number of comments.

Endpoints
- post/admin/api/latest/blogs/{blog_
id}/articles. json Creates an article for a blog - get/admin/api/latest/articles/authors.
json Retrieves a list of all article authorsdeprecated - get/admin/api/latest/articles/tags.
json Retrieves a list of all article tags - get/admin/api/latest/blogs/{blog_
id}/articles. json Retrieves a list of all articles from a blog - get/admin/api/latest/blogs/{blog_
id}/articles/{article_ id}. json Receive a single Article - get/admin/api/latest/blogs/{blog_
id}/articles/count. json Retrieves a count of all articles from a blog - get/admin/api/latest/blogs/{blog_
id}/articles/tags. json Retrieves a list of all article tags from a specific blogdeprecated - put/admin/api/latest/blogs/{blog_
id}/articles/{article_ id}. json Updates an article - del/admin/api/latest/blogs/{blog_
id}/articles/{article_ id}. json Deletes an article
The Article resource
Properties
The name of the author of the article.
The ID of the blog containing the article.
The text of the body of the article, complete with HTML markup.
The ID of the article.
A human-friendly unique string for the article that's automatically generated from the article's title. The handle is used in the article's URL.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
The additional information attached to an Article object. It has the following properties:
Show metafields properties
- key: An identifier for the metafield. (maximum: 30 characters)
- namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters)
- value: The information to be stored as metadata.
- type: The metafield's information type. Refer to the full list of types.
- description (optional): Additional information about the metafield.
For more information on attaching metadata to Shopify resources, see the Metafield resource.
Whether the article is visible.
The date and time (ISO 8601 format) when the article was published.
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.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The Article resource
Anchor to POST request, Creates an article for a blogpostCreates an article for a blog
Create an article with HTML markup for a blog
Create an article with HTML markup for a blog
Show article properties
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
Create an article with a base64 encoded image
Create an article with a base64 encoded image
Show article properties
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
Create an article with a metafield
Create an article with a metafield
Show article properties
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
The additional information attached to an Article object. It has the following properties:
Show metafields properties
- key: An identifier for the metafield. (maximum: 30 characters)
- namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters)
- value: The information to be stored as metadata.
- type: The metafield's information type. Refer to the full list of types.
- description (optional): Additional information about the metafield.
For more information on attaching metadata to Shopify resources, see the Metafield resource.
Create an article with an image, which will be downloaded by Shopify
Create an article with an image, which will be downloaded by Shopify
Show article properties
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
Create an unpublished article for a blog
Create an unpublished article for a blog
Show article properties
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
Whether the article is visible.
Creating an article without a title fails and returns an error
Creating an article without a title fails and returns an error
/admin/api/2025-07/blogs/241253187/articles. json
Response
/admin/api/2025-07/articles/authors. json
Response
The maximum number of tags to retrieve.
A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag.
/admin/api/2025-07/articles/tags. json
Response
Anchor to GET request, Retrieves a list of all articles from a bloggetRetrieves a list of all articles from a blog
Retrieves a list of all articles from a blog. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
Filter articles by article author.
Show articles created before date (format: 2014-04-25T16:15:47-04:00).
Show articles created after date (format: 2014-04-25T16:15:47-04:00).
Show only certain fields, specified by a comma-separated list of field names.
Retrieve an article with a specific handle.
The maximum number of results to retrieve.
Show articles published before date (format: 2014-04-25T16:15:47-04:00).
Show articles published after date (format: 2014-04-25T16:15:47-04:00).
Retrieve results based on their published status.
Show published_status properties
published: Show only published articles.
unpublished: Show only unpublished articles.
any: Show articles of any published status.
Restrict results to after the specified ID.
Retrieve a list of articles from a blog
Retrieve a list of articles from a blog
Retrieve all articles from a blog after a specified ID
Retrieve all articles from a blog after a specified ID
Restrict results to after the specified ID.
/admin/api/2025-07/blogs/241253187/articles. json
Response
Anchor to GET request, Receive a single ArticlegetReceive a single Article
Retrieves a single article
Show only certain fields, specifed by a comma-separated list of field names.
Retrieve a single article
Retrieve a single article
/admin/api/2025-07/blogs/241253187/articles/134645308. json
Response
Anchor to GET request, Retrieves a count of all articles from a bloggetRetrieves a count of all articles from a blog
Count articles created before date (format: 2014-04-25T16:15:47-04:00).
Count articles created after date (format: 2014-04-25T16:15:47-04:00).
Count articles published before date (format: 2014-04-25T16:15:47-04:00).
Count articles published after date (format: 2014-04-25T16:15:47-04:00).
Count articles with a given published status.
Show published_status properties
published: Count only published articles.
unpublished: Count only unpublished articles.
any: Count all articles.
Count articles last updated before date (format: 2014-04-25T16:15:47-04:00).
Count articles last updated after date (format: 2014-04-25T16:15:47-04:00).
Count all a blog's articles
Count all a blog's articles
/admin/api/2025-07/blogs/241253187/articles/count. json
Response
The maximum number of tags to retrieve.
A flag for ordering retrieved tags. If present in the request, then the results will be ordered by popularity, starting with the most popular tag.
/admin/api/2025-07/blogs/241253187/articles/tags. json
Response
Anchor to PUT request, Updates an articleputUpdates an article
Add a metafield to an existing article
Add a metafield to an existing article
Show article properties
The ID of the article.
The additional information attached to an Article object. It has the following properties:
Show metafields properties
- key: An identifier for the metafield. (maximum: 30 characters)
- namespace: A container for a set of metadata. Namespaces help distinguish between metadata created by different apps. (maximum: 20 characters)
- value: The information to be stored as metadata.
- type: The metafield's information type. Refer to the full list of types.
- description (optional): Additional information about the metafield.
For more information on attaching metadata to Shopify resources, see the Metafield resource.
Hide a published article
Hide a published article
Show article properties
The ID of the article.
Whether the article is visible.
Remove the image from an article
Remove the image from an article
Show article properties
The ID of the article.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
Update an article's image
Update an article's image
Show article properties
The ID of the article.
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
Update an existing article of a blog
Update an existing article of a blog
Show article properties
The ID of the article.
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
Update the alt text for an article image
Update the alt text for an article image
Show article properties
The ID of the article.
The title of the article.
The name of the author of the article.
A comma-separated list of tags. Tags are additional short descriptors formatted as a string of comma-separated values.
The text of the body of the article, complete with HTML markup.
The date and time (ISO 8601 format) when the article was published.
An image associated with the article. It can have the following properties:
Show image properties
- attachment: An image attached to article returned as Base64-encoded binary data.
- src: A source URL that specifies the location of the image.
- alt: Alternative text that describes the image.
/admin/api/2025-07/blogs/241253187/articles/134645308. json
Response
Anchor to DELETE request, Deletes an articledelDeletes an article
Delete an existing article from a blog
Delete an existing article from a blog