Skip to content

List a post's comments

GET
/public/stores/{storeRef}/blog/posts/{postId}/comments
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/public/stores/example/blog/posts/1/comments \
--header 'x-storefront-api-key: <x-storefront-api-key>'

Returns all approved comments on a post, oldest first, with their reply links in parent_comment_id. With a signed-in customer’s token, that customer’s own comments that are still waiting for approval are included too. Commenters’ emails are never returned; is_approved is. A post that does not exist in the store answers 404.

postId
required
integer

The post ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
Array<object>
object
id
required

Comment ID.

number
blog_post_id
required

ID of the post the comment belongs to.

number
nullable
parent_comment_id
required

ID of the comment this one replies to, or null for a top-level comment.

number
nullable
author_name
required

Name of the commenter.

string
author_website

Website of the commenter, or null.

string
nullable
content
required

Comment text.

string
is_approved

Whether the comment is approved and visible on the storefront.

boolean
nullable
created_at

When the comment was created, as an ISO 8601 timestamp.

string
nullable

Example generated

[
{
"id": 1,
"blog_post_id": 1,
"parent_comment_id": 1,
"author_name": "example",
"author_website": "example",
"content": "example",
"is_approved": true,
"created_at": "example"
}
]

The request is malformed or failed validation.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}