Skip to main content
GET
Get comments for article (public)

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Pattern: ^[a-fA-F0-9]{24}$
Example:

"{{objectId}}"

Query Parameters

page
integer
Required range: x >= 1
Example:

1

limit
integer

Defaults to 20, capped at 100

Required range: 1 <= x <= 100
Example:

20

sortOrder
enum<string>

Sort by creation time. Any value other than asc means newest first.

Available options:
asc,
desc
Example:

"desc"

parentId
string

Return only replies to this comment. Takes precedence over rootOnly.

Pattern: ^[a-fA-F0-9]{24}$
Example:

"{{objectId}}"

rootOnly
string

Set to true to return only top-level comments. Ignored when parentId is provided.

Example:

"true"

Response

OK