Comments

Get Comment Thread

Get details of a specific comment thread.

Timing of comment threads

There may be a delay of up to 5 minutes before new comments appear in the system.

Required scope | comments:read

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
comment_thread_idstringRequiredformat: "objectid"
Unique identifier for a Comment Thread

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

localeIdstringOptional
Unique identifier for a specific locale. Applicable, when using localization.
offsetdoubleOptional
Offset used for pagination if the results have more than limit records
limitdoubleOptional

Maximum number of records to be returned (max limit: 100)

sortByenumOptional
Sort results by the provided value. Only allowed when sortOrder is provided.
Allowed values:
sortOrderenumOptional
Sorts the results by asc or desc
Allowed values:

Response

Request was successful
idstring
Unique identifier for the comment thread
siteIdstring
The site unique identifier
pageIdstring
The page unique identifier
breakpointstring
The breakpoint the comment was left on
urlstring
The URL of the page the comment was left on
contentstring
The content of the comment reply
isResolvedboolean
Boolean determining if the comment thread is resolved
authorobject
mentionedUserslist of objects
List of mentioned users. This is an empty array until email notifications are sent, which can take up to 5 minutes after the comment is created.
createdOnstringformat: "date-string"
The date the item was created
lastUpdatedstringformat: "date-string"
The date the item was last updated
localeIdstring or null
The locale unique identifier
itemIdstring or null
The item unique identifier

Errors