Qodex.ai

List Comments

GET {{baseUrl}}/api/v2/community/posts/:post_id/comments

Lists all comments on a specific post or all the comments created by a specific user. When listing comments by specific user, the comments of the user making the request can be listed by specifying me as the id.

Allowed for

  • End users

Pagination

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Sideloads

You can sideload related records with the include query string parameter. The following sideloads are supported:

NameWill sideload
usersauthors
postsposts

See Sideloading related records.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"comments":[{"body":"\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","official":"\u003cboolean\u003e","post_id":"\u003cinteger\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"},{"body":"\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","official":"\u003cboolean\u003e","post_id":"\u003cinteger\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"}]}