Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Comments

Get Comments

Get all comments for a given task or project.

Exactly one of task_id or project_id arguments is required. Providing neither or both will return an error.

This is a paginated endpoint. See the Pagination guide for details on using cursor-based pagination.

get/api/v1/comments

Query parameters

project_idstring nullable

String ID of the project

Example:6XGgm6PHrGgMpCFX
task_idstring nullable

String ID of the task

Example:6XGgmFVcrG5RRjVr
cursorstring nullable

An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request

Example:14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55
limitinteger

The number of objects to return in a page

Example:50
public_keystring nullable

Public project access key.

Example:550e8400-e29b-41d4-a716-446655440000

Response

Successful Response

next_cursorstring nullable required

Cursor for the next page of results, or null when there are no more results.

Example response

{
  "results": [],
  "next_cursor": "14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55"
}