CommentService

ListComments

Retrieves comments using an optional filter.

get/api/v1/comments

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/comments
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

The maximum number of comments to return. Defaults to 50, max 1000.

pageTokenstring

A page token, received from a previous ListComments call.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are comment_id, resource_id, entity_type, created_by_user_id, created_date, and modified_date.

orderBystring

How to order the retrieved comments. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date and modified_date. Defaults to created_date ascending (oldest-first).

Response

A successful response.

nextPageTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.