Productive icon

Productive

Interact with the Productive API

Actions508

Comments → Get comments

AI-generated

Summary

Retrieve comments from the Productive API with optional filters and pagination controls.

Inputs

  • Return All — Whether to return all results or only up to a given limit (only applicable for the 'Get all comments' operation).
  • Limit — Maximum number of comment results to return; used only if 'Return All' is false.
  • Page Number — The page number of results to retrieve; defaults to 1 and used when 'Return All' is false.
  • Page Size — Number of comments per page returned by the API; defaults to 30 with a maximum of 200, used when 'Return All' is false.
  • Filter Query String — A raw filter query string (e.g., filter[field_name]=value) overriding all other filter options if provided.
  • Filters — One or more filters on comment fields such as Discussion ID, Draft status, Page ID, Project ID, Task ID, or Workflow Status Category ID; ignored if a filter query string is provided.

Output shape

a list of comment records retrieved from the Productive API.

If multiple items exist, results are paginated unless 'Return All' is set to true. Filters refine which comments are returned. Errors per item will be surfaced with error messages if 'Continue on Fail' is enabled.

Examples

Example 1: Retrieve up to 50 comments on page 1 with default page size, filtering comments by a specific Task ID equals '12345'.

Set 'Return All' to false, 'Limit' to 50, 'Page Number' to 1, 'Page Size' to 30, and add a Filter with 'Filter Field' as Task ID, 'Operation' as Equals, 'Value' as '12345'.

Discussion