List Comments
GET {{baseUrl}}/api/v2/help_center/:locale/articles/:article_id/comments
Lists the comments created by a specific user, or all comments made by all users on a specific article.
The {locale} for the article comments is required only for end users. Admins and agents can omit it.
Allowed for
- End users
End-users can only list their own comments. If listing comments by user, they must specify me as the id.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Sideloads
The following sideloads are supported:
| Name | Will sideload |
|---|---|
| users | authors |
| articles | articles |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"comments":[{"body":"\u003cstring\u003e","locale":"\u003cstring\u003e","author_id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","non_author_editor_id":"\u003cinteger\u003e","non_author_updated_at":"\u003cdateTime\u003e","source_id":"\u003cinteger\u003e","source_type":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"},{"body":"\u003cstring\u003e","locale":"\u003cstring\u003e","author_id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","non_author_editor_id":"\u003cinteger\u003e","non_author_updated_at":"\u003cdateTime\u003e","source_id":"\u003cinteger\u003e","source_type":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"}]}