List Comment Threads

GET

List all comment threads for a site.

Required scope | comments:read

Path parameters

site_idstringRequired

Unique identifier for a Site

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

commentslist of objects

paginationobject

Errors

GET

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

200Retrieved

1 {
2   "comments": [
3     {
4       "id": "679d2ddb5196117ad04d1ffa",
5       "siteId": "679826b3b20b045e176bc4b5",
6       "pageId": "679826b3b20b045e176bc4bc",
7       "breakpoint": "main",
8       "url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
9       "content": "Let's go to the pub! [[6287ec36a841b25637c663df]] ",
10       "isResolved": false,
11       "author": {
12         "userId": "6287ec36a841b25637c663df",
13         "email": "ford.prefect@heartofgold.spaceship",
14         "name": "Ford Prefect"
15       },
16       "mentionedUsers": [
17         {
18           "userId": "6287ec36a841b25637c663df",
19           "email": "arthur.dent@heartofgold.spaceship",
20           "name": "Arthur Dent"
21         }
22       ],
23       "createdOn": "2025-01-31T20:08:59.759Z",
24       "lastUpdated": "2025-01-31T20:08:59.759Z",
25       "localeId": "67993753d910db250db64b3e",
26       "itemId": "580e64008c9a982ac9b8b754"
27     },
28     {
29       "id": "679d2ddb5196117ad04d1ffc",
30       "siteId": "679826b3b20b045e176bc4b5",
31       "pageId": "679826b3b20b045e176bc4bc",
32       "breakpoint": "main",
33       "url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
34       "content": "You have five minutes left to drink it [[6287ec36a841b25637c663df]] ",
35       "isResolved": false,
36       "author": {
37         "userId": "6287ec36a841b25637c663df",
38         "email": "ford.prefect@heartofgold.spaceship",
39         "name": "Ford Prefect"
40       },
41       "mentionedUsers": [
42         {
43           "userId": "6287ec36a841b25637c663df",
44           "email": "arthur.dent@heartofgold.spaceship",
45           "name": "Arthur Dent"
46         }
47       ],
48       "createdOn": "2025-01-31T20:08:59.759Z",
49       "lastUpdated": "2025-01-31T20:08:59.759Z",
50       "localeId": "67993753d910db250db64b3e",
51       "itemId": "580e64008c9a982ac9b8b754"
52     }
53   ],
54   "pagination": {
55     "limit": 2,
56     "offset": 0,
57     "total": 2
58   }
59 }

Get Comment Thread

Up Next

Built with

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

1	{
2	"comments": [
3	{
4	"id": "679d2ddb5196117ad04d1ffa",
5	"siteId": "679826b3b20b045e176bc4b5",
6	"pageId": "679826b3b20b045e176bc4bc",
7	"breakpoint": "main",
8	"url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
9	"content": "Let's go to the pub! [[6287ec36a841b25637c663df]] ",
10	"isResolved": false,
11	"author": {
12	"userId": "6287ec36a841b25637c663df",
13	"email": "ford.prefect@heartofgold.spaceship",
14	"name": "Ford Prefect"
15	},
16	"mentionedUsers": [
17	{
18	"userId": "6287ec36a841b25637c663df",
19	"email": "arthur.dent@heartofgold.spaceship",
20	"name": "Arthur Dent"
21	}
22	],
23	"createdOn": "2025-01-31T20:08:59.759Z",
24	"lastUpdated": "2025-01-31T20:08:59.759Z",
25	"localeId": "67993753d910db250db64b3e",
26	"itemId": "580e64008c9a982ac9b8b754"
27	},
28	{
29	"id": "679d2ddb5196117ad04d1ffc",
30	"siteId": "679826b3b20b045e176bc4b5",
31	"pageId": "679826b3b20b045e176bc4bc",
32	"breakpoint": "main",
33	"url": "https://webflow.com/design/site-slug-4ec832?workflow=comment&commentId=679d2ddb5196117ad04d1ff8&pageId=679826b3b20b045e176bc4bc",
34	"content": "You have five minutes left to drink it [[6287ec36a841b25637c663df]] ",
35	"isResolved": false,
36	"author": {
37	"userId": "6287ec36a841b25637c663df",
38	"email": "ford.prefect@heartofgold.spaceship",
39	"name": "Ford Prefect"
40	},
41	"mentionedUsers": [
42	{
43	"userId": "6287ec36a841b25637c663df",
44	"email": "arthur.dent@heartofgold.spaceship",
45	"name": "Arthur Dent"
46	}
47	],
48	"createdOn": "2025-01-31T20:08:59.759Z",
49	"lastUpdated": "2025-01-31T20:08:59.759Z",
50	"localeId": "67993753d910db250db64b3e",
51	"itemId": "580e64008c9a982ac9b8b754"
52	}
53	],
54	"pagination": {
55	"limit": 2,
56	"offset": 0,
57	"total": 2
58	}
59	}