Get all comments for one entity (program, task, or request)

Retrieves all comments associated with a specific entity (program, task, or request) with support for filtering
by creator, pagination, and sorting. This endpoint provides comprehensive comment data including metadata, creation timestamps, and author information for building collaborative interfaces.

Key Features:

  • Supports filtering by multiple creator IDs simultaneously
  • Provides cursor-based pagination for efficient data retrieval
  • Offers flexible sorting options for optimal display ordering
  • Returns complete comment metadata including author details
  • Automatically handles permission filtering to show only accessible comments

Authorization Logic:

  1. User must have a valid JWT token with viewing or management scopes
  2. Token is valid for this operation
  3. User must have access to the specified entity and space
  4. Comments are filtered based on user's access permissions

Usage Example:

Retrieve recent comments on a program to display discussion activity and enable team collaboration features.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

string
required

The unique identifier of the entity (program, task, or request) to retrieve comments from. This entity must exist within the specified space and be accessible to the authenticated user.

Query Params
creatorIds
array of strings

Optional array of user IDs to filter comments by creator. When provided, only comments created by the specified users will be returned. Useful for viewing comments from specific team members or stakeholders.

creatorIds
string

Optional cursor for pagination. Use the cursor from the previous response's metadata to retrieve the next page
of results. Enables efficient navigation through large comment sets.

int32

Optional limit for the number of comments to return per page. Defaults to 50 if not specified. Maximum value
may be restricted by system configuration to prevent performance issues.

sort
array of strings

Optional array of sort criteria in format 'field:direction'. Supported fields: createdAt, updatedAt.
Supported directions: asc, desc. Default sorting is by creation date in descending order.

sort
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json