Get Comment Thread

GET

Get details of a specific comment thread.

Required scope | comments:read

Path parameters

site_idstringRequired

Unique identifier for a Site

comment_thread_idstringRequired

Unique identifier for a Comment Thread

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: createdOnlastUpdated

sortOrderenumOptional

Sorts the results by asc or desc

Allowed values: ascdesc

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.

createdOnstring

The date the item was created

lastUpdatedstring

The date the item was last updated

localeIdstringOptional

The locale unique identifier

itemIdstringOptional

The item unique identifier

Errors

GET

1 curl -G https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/comments/580e63e98c9a982ac9b8b741 \
2      -H "Authorization: Bearer <token>" \
3      -d localeId=65427cf400e02b306eaa04a0

200Retrieved

1 {
2   "id": "580e64008c9a982ac9b8b754",
3   "siteId": "580e64008c9a982ac9b8b754",
4   "pageId": "580e64008c9a982ac9b8b754",
5   "breakpoint": "main",
6   "url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
7   "content": "This is a comment reply",
8   "isResolved": true,
9   "author": {
10     "userId": "userId",
11     "email": "email",
12     "name": "name"
13   },
14   "mentionedUsers": [
15     {
16       "userId": "6287ec36a841b25637c663df",
17       "email": "arthur.dent@heartofgold.spaceship",
18       "name": "Arthur Dent"
19     }
20   ],
21   "createdOn": "2023-03-17T18:47:35.560Z",
22   "lastUpdated": "2023-03-17T18:47:35.560Z",
23   "localeId": "580e64008c9a982ac9b8b754",
24   "itemId": "580e64008c9a982ac9b8b754"
25 }

List Comment Replies

Up Next

Built with

1	curl -G https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/comments/580e63e98c9a982ac9b8b741 \
2	-H "Authorization: Bearer <token>" \
3	-d localeId=65427cf400e02b306eaa04a0

1	{
2	"id": "580e64008c9a982ac9b8b754",
3	"siteId": "580e64008c9a982ac9b8b754",
4	"pageId": "580e64008c9a982ac9b8b754",
5	"breakpoint": "main",
6	"url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
7	"content": "This is a comment reply",
8	"isResolved": true,
9	"author": {
10	"userId": "userId",
11	"email": "email",
12	"name": "name"
13	},
14	"mentionedUsers": [
15	{
16	"userId": "6287ec36a841b25637c663df",
17	"email": "arthur.dent@heartofgold.spaceship",
18	"name": "Arthur Dent"
19	}
20	],
21	"createdOn": "2023-03-17T18:47:35.560Z",
22	"lastUpdated": "2023-03-17T18:47:35.560Z",
23	"localeId": "580e64008c9a982ac9b8b754",
24	"itemId": "580e64008c9a982ac9b8b754"
25	}