Get Blog Post

GET

https://api.bigcommerce.com/stores/:store_hash/v2/blog/posts/:id

GET

/stores/:store_hash/v2/blog/posts/:id

curl https://api.bigcommerce.com/stores/store_hash/v2/blog/posts/1 \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Response

{
  "author": "BigCommerce",
  "body": "<p>Customize your site, manage shipping and payments, and list your products on Amazon, eBay, and Facebook by Meta with the #1 ecommerce platform. </p>",
  "id": 3,
  "is_published": true,
  "meta_description": "Welcome Post",
  "meta_keywords": "BigCommerce, welcome, ecommerce",
  "preview_url": "/blog/welcome-bigcommerce/",
  "published_date": {
    "timezone_type": 1,
    "date": "2018-05-18T08:26:42.000Z",
    "timezone": "+00:00"
  },
  "published_date_iso8601": "2018-05-18T13:26:42.000Z",
  "summary": "<p>We power ecommerce websites for successful retailers all over the world</p>",
  "tags": [
    "BigCommerce",
    "welcome",
    "ecommerce"
  ],
  "thumbnail_path": "",
  "title": "Welcome to BigCommerce",
  "url": "/blog/welcome-bigcommerce/"
}

Returns a single Blog Post.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Content	modify	`store_v2_content`
Content	read-only	`store_v2_content_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

idintegerRequired

ID of the blog post.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Response

authorstring or nullOptional

Name of the blog post’s author.

bodystringOptional

Text body of the blog post.

idintegerOptionalRead-only

ID of this blog post. READ-ONLY.

is_publishedbooleanOptionalDefaults to false

Whether the blog post is published. If you want the post to be or remain published following the request, you must set the field explicitly to true, even if the blog post was already published prior to the request.

meta_descriptionstring or nullOptional

Description text for this blog post’s <meta/> element.

meta_keywordsstring or nullOptional

Keywords for this blog post’s <meta/> element.

preview_urlstringOptionalRead-only

URL to preview the blog post. READ-ONLY.

published_dateobjectOptional

published_date_iso8601stringOptional

Published date in ISO 8601 format.

summarystringOptionalRead-only

Summary of the blog post. READ-ONLY.

tagslist of stringsOptional

Tags to characterize the blog post.

thumbnail_pathstring or nullOptional

Local path to a thumbnail uploaded to /product_images/ using WebDAV.

titlestringOptional

Title of this blog post.

urlstringOptional

URL for the public blog post.