Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

page
integer

Page number

limit
integer

Number of results to return

filters
object

Filter comments. Use filters[createdAfter] to fetch only comments created after a point in time, for example the createdAt of the last comment you synced.

properties
enum<string>[]

Select the comment properties to return. Comments return only id and object unless other properties are requested. Request author.<property> (for example author.email) to include the author, and files.<property> (for example files.downloadUrl) to include the attached files; both nested objects always carry their id, object and url

Available options:
taskId,
body,
author.createdAt,
author.updatedAt,
author.firstName,
author.lastName,
author.avatar,
author.email,
author.name,
files.name,
files.thumbnail,
files.size,
files.downloadUrl,
files.expiresAt,
files.uploadStatus,
files.mimeType,
createdAt,
updatedAt

Response

List of workspace plan task comments

data
object