Skip to main content
GET
query the comments held for review in a community.

Authorizations

Authorization
string
header
required

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

Path Parameters

communityId
string
required
Required string length: 1 - 900

Query Parameters

postId
string

Restrict the result to the comments written on one post.

Maximum string length: 900
startDate
string

Earliest comment creation date to return, as YYYY-MM-DD. The range is read against createdAt — when the comment was written — not against the time it entered the queue.

Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

Latest comment creation date to return, as YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
timeZone
string

IANA time zone the startDate and endDate boundaries are resolved in. Defaults to UTC.

Example:

"Asia/Bangkok"

options
object

Skip/limit pagination. This endpoint has no scrollable form.

Response

Comment Information

comments
object[]
commentChildren
object[]
communityUsers
object[]
users
object[]
roles
object[]
files
object[]
paging
object