latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Comments

Find comments.

Returns comments matching the given search criteria.

Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored.

The returned comments satisfy all constraints that are specified in this search criteria.

By default, the result contains up to 1000 comments.

get/comments

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

parentIdstring uuid

The ID of the comment which the reply comments should be searched for

userIdstring uuid

The ID of the user. By default, filters comments to include only those created by this user.

baseResourceIdstring uuid

The ID of the resource which the searched comments refer to.

rootCommentboolean

Whether the searched comments should be root comments (not reply comments).

resolvedboolean

Whether the searched comments should be resolved.

userThreadsboolean

Specifies whether to search for root comments created by or mentioning the user userId, or root comments with replies created by or mentioning the user userId.

sortOrder'ASC' | 'DESC'

The order of sorting on the date the comment was created.

Response

The paged response with found comments.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.