GET
/
comments
/
v3
/
comments
List comments
curl --request GET \
  --url https://api.hubapi.com/comments/v3/comments \
  --header 'Authorization: Bearer <token>'
{
  "objects": [
    {
      "id": 409695529,
      "portalId": 62515,
      "contentId": 6860971618,
      "contentTitle": "Test Blog",
      "contentPermalink": "http://demo-hubapi.hs-sites.com/tb-es/test-blog",
      "collectionId": 6513512292,
      "createdAt": 1550182973778,
      "deletedAt": 0,
      "userName": "test testerson",
      "firstName": "test testerson",
      "lastName": "",
      "userEmail": "test@gmail.com",
      "comment": "sample test comment",
      "userUrl": "",
      "state": "APPROVED",
      "userIp": null,
      "userReferrer": null,
      "userAgent": null,
      "contentAuthorEmail": "testapi@hubspot.com",
      "contentAuthorName": "Test 2",
      "contentCreatedAt": 1545651277462,
      "threadId": "0001.0000.0000.0000.0000.0000.0000.0000.0000.0000",
      "replyingTo": null,
      "parentId": 0,
      "legacyId": 0,
      "extraContext": null,
      "parent": null
    }
  ],
  "total": 17,
  "limit": 1,
  "offset": 0
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer

The number of items to return. Defaults to 20.

​
offset
integer

The offset set to start returning rows from. Defaults to 0.

​
portalId
integer

The portal number associated with your api key/token.

​
state
enum<string>

Comment state. Options are: APPROVED, SPAM, REJECTED, PENDING_MODERATION.

Available options:
APPROVED,
SPAM,
REJECTED,
PENDING_MODERATION
​
contentId
integer

Allows you get comments for a specific blog post. Include contentId={post ID} to only get comments for that post.

​
reverse
boolean

If you want comments oldest to newest, supply 'reverse=true'.

​
query
string

Matches arbitrary text within a comment.

Response

200
application/json

A list of blog comments.

The response is of type object.