Retrieve comments with filtering, sorting, pagination, access checks, and optional attachments.
The method returns all native fields from the comments table, plus related project, task, and track data. If with_attachments is provided, the response also includes attachments linked to the returned comments.
The number in the URL path (/1/) is the organization identifier — referred to as account_id.
This value must match the account associated with the provided session_id or token.
This endpoint supports both:
GET https://api.doboard.com/42/comment_get?comment_get?task_id=101&status=ACTIVE&length=25&with_attachments=1&session_id=abc123xyz
In this example:
42 is the organization/account IDtask_id=101 returns comments for task 101.status=ACTIVE returns only active comments.length=25 limits the response to 25 comments.with_attachments=1 adds the attachments array to the response.session_id=abc123xyz is used for authentication.If the account ID in the URL does not match the account tied to the session, the request will be rejected.
Required
The method requires a valid session or guest/public access context:
session_id – for authenticated userstoken – for guest accessApplies rate-limiting: max 50 failed attempts per IP per 10 minutes
Supports guest users by returning guest context with user_type = GUEST
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id |
string | Yes | – | Authenticated user session ID. |
token |
string | No | – | Guest/public access token, if public access is enabled. |
comment_id |
int / array | No | – | One or multiple comment IDs, comma-separated or array. |
task_id |
int | No | – | Filter comments by task ID. |
track_id |
int | No | – | Filter comments by track ID. |
user_id |
int | No | – | Filter comments by author/user ID. |
status |
string | No | – | Comment status. Allowed values: ACTIVE, REMOVED. |
with_attachments |
int / boolean | No | – | If set, returns attachments linked to the selected comments. |
start |
int | No | 0 |
Offset for pagination. |
length |
int | No | 100 |
Page size. Allowed values: 10, 25, 50, 100. |
order_column |
string | No | created |
Sorting column. Allowed value: created. |
order_dir |
string | No | DESC |
Sort direction: asc or desc. |
* Either session_id or token is required.
{
"data": {
"operation_status": "SUCCESS",
"comments": [
{
"comment_id": 501,
"user_id": 5,
"project_id": 7,
"track_id": 12,
"task_id": 101,
"created": "2026-05-01 10:15:00",
"updated": "2026-05-01 10:20:00",
"edited": null,
"edited_user_id": null,
"comment": "Please check this task.",
"comment_text": "Please check this task.",
"comment_history": [],
"status": "ACTIVE",
"reactions_count": 0,
"pin": 0,
"editing_user_id": null,
"editing_time": null,
"label_id": null,
"meta": "",
"project_name": "Web Platform",
"task_name": "Fix login bug",
"task_track_id": 12,
"track_name": "Sprint 42"
}
],
"attachments": [
{
"attachment_id": 301,
"created": "2026-05-01 10:16:00",
"updated": null,
"filename": "screenshot.png",
"URL": "https://example.com/path/screenshot.png",
"URL_thumbnail": "https://example.com/path/screenshot-thumb.png",
"user_id": 5,
"comment_id": 501,
"task_id": 101,
"track_id": 12,
"project_id": 7,
"mime_content_type": "image/png",
"attachment_order": 0,
"file_size": 245760,
"task_name": "Fix login bug",
"project_name": "Web Platform"
}
],
"records_filtered": 1
}
}
attachmentsis returned only when with_attachments is provided.
comments[]
| Field | Type | Description |
|---|---|---|
comment_id |
int | Unique comment identifier. |
user_id |
int | ID of the user who created the comment. Nullable. |
project_id |
int | Project ID linked to the comment. Nullable. May be hidden in some guest responses. |
track_id |
int | Track ID linked to the comment. Nullable. |
task_id |
int | Task ID linked to the comment. Nullable. |
created |
datetime | Date and time when the comment was created. |
updated |
datetime | Date and time when the comment was last updated. Nullable. |
edited |
datetime | Date and time when the comment was edited. Nullable. |
edited_user_id |
int | ID of the user who edited the comment. Nullable. |
comment |
mediumtext | Full comment content. |
comment_text |
string | Short plain-text version of the comment, up to 512 characters. |
comment_history |
array | Decoded comment edit history. Stored as text in DB, decoded from JSON when returned. |
status |
enum | Comment status: ACTIVE, REMOVED. |
reactions_count |
mediumint | Number of reactions added to the comment. |
pin |
tinyint | Pin flag. 1 means pinned, 0 means not pinned. |
editing_user_id |
int | ID of the user currently editing the comment. Nullable. |
editing_time |
datetime | Time when editing started or was last updated. Nullable. |
label_id |
int | ID of the label linked to the comment. Nullable. |
meta |
text | Additional metadata stored for the comment. |
project_name |
string | Project name from the related project. May be hidden in some guest responses. |
task_name |
string | Task name from the related task. |
task_track_id |
int | Track ID of the related task. May be hidden in some guest responses. |
track_name |
string | Track name. Uses comment track name or task track name. May be hidden in some guest responses. |
attachments[]
| Field | Type | Description |
|---|---|---|
attachment_id |
int | Unique attachment identifier. |
created |
datetime | Date and time when the attachment was created. |
updated |
datetime | Date and time when the attachment was last updated. Nullable. |
filename |
string | Original or stored attachment filename, up to 255 characters. |
URL |
string | Full attachment URL, up to 1024 characters. |
URL_thumbnail |
string | Thumbnail URL, up to 1024 characters. Nullable. |
user_id |
int | ID of the user who uploaded the attachment. |
comment_id |
int | ID of the comment linked to the attachment. |
task_id |
int | ID of the related task. Nullable in the attachments table, but returned from the selected attachment/comment context. |
track_id |
int | ID of the related track. Nullable. |
project_id |
int | ID of the related project. Nullable. |
mime_content_type |
string | MIME content type of the attachment, up to 255 characters. |
attachment_order |
int | Sort order of the attachment. |
file_size |
bigint | File size in bytes. |
task_name |
string | Name of the related task. |
project_name |
string | Name of the related project. |
| HTTP Code | error_no |
Message | Description |
|---|---|---|---|
401 |
– | Unauthorized |
Missing or invalid session/token. |
200 |
2101 |
status must be in ('ACTIVE','REMOVED') |
Invalid status value. |
200 |
0 |
Internal API Error |
Internal error. |
Admin users see all projects; regular users see only those they're linked to via projects_users.
Rate-limiting prevents brute-force attempts on session validation.
This endpoint supports pagination and combined filters (e.g., task_id + status).
If comment_history is present, it is decoded from JSON before returning.
If with_attachments is provided, the response includes an additional attachments array.
In guest task mode without project context, project and track fields are hidden in the response: project_id, project_name, task_track_id and track_name.