Method Details
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Scope:
List comments from your HubSpot blogs. Supports paging and filtering.
There's a new version of the HubSpot API
As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing
Required Scope:
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. |
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 |
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 |