Get comments

Get all comments on a task.

GET

/ v1 / comments

Authorization

X-API-Key

string

required

Header with the name X-API-Key where the value is your API key.

Query parameters

cursor

string

Use if a previous request returned a cursor. Will page through results.
taskId

string

required

The task for which all comments should be returned.

Response

200 - application/json - object

meta

object

required

Contains the nextCursor, if one exists, along with the pageSize.
- nextCursor
  
  string
  
  Make the same query with the new cursor to get more results.
- pageSize
  
  number
  
  The number of results in this response.
comments

array<object>

required

The list of comments on a given task.
- id
  
  string
  
  required
  
  The ID of the comment.
- taskId
  
  string
  
  required
  
  The ID of the task.
- content
  
  string
  
  required
  
  The HTML content of the comment.
- createdAt
  
  datetime
  
  required
  
  When this comment was created.
- creator
  
  object
  
  required
  
  The user who created the comment.
  id
  
  string
  
  The user id of the creator.
  
  name
  
  string
  
  The name of the creator.
  
  email
  
  string
  
  The email of the creator.