List comments

Last updated June 17, 2020

GET /comments/v3/comments

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

List comments from your HubSpot blogs. Supports paging and filtering.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 Used to authenticate the request. Please see this page for more details about authentication.

Optional query string filters & options

Parameter name Description
limit The number of items to return. Defaults to 20
offset The offset set to start returning rows from. Defaults to 0.
portalId The portal number associated with your api key/token
state Comment state. Options are: APPROVED, SPAM, REJECTED, PENDING_MODERATION
contentId Allows you get comments for a specific blog post. Include 'contentId={post ID}' to only get comments for that post.
reverse If you want comments oldest to newest, supply 'reverse=true'
query Matches arbitrary text within a comment

JSON Fields returned in the response

Parameter name Type Description
comment string The full text of the comment
createdAt long Unix timestamp when the comment was made
state string-enum State of the comment; approved, rejected, etc.
contentId long The id of the parent blog post
id long The unique id of comment
userReferrer string The URL the comment was submitted from
userIp string The IP address of the person submitting the comment
userAgent string The user agent of the commenters browser
userEmail string The email address of the user submitting the comment
userName string The name of the person submitting the comment
userWebsite string The web site of the user submitting the comment

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: api.hubapi.com/comments/v3/comments?hapikey=demo&limit=1 Example Response: { "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": { "id": 0, "portalId": 0, "contentId": 0, "contentTitle": "", "contentPermalink": null, "collectionId": 0, "createdAt": 0, "deletedAt": 0, "userName": "", "firstName": "", "lastName": "", "userEmail": null, "comment": "", "userUrl": "", "state": "PENDING_AKISMET", "userIp": null, "userReferrer": null, "userAgent": null, "contentAuthorEmail": null, "contentAuthorName": null, "contentCreatedAt": 0, "threadId": "0001.0000.0000", "replyingTo": null, "parentId": 0, "legacyId": 0, "extraContext": null, "parent": null } } ], "total": 17, "limit": 1, "offset": 0 }