Projects
- GET/projects
- GET/projects/{id}
- POST/tasks
- GET/tasks/{id}
- PUT/tasks/{id}
- PATCH/tasks/{id}
- DELETE/tasks/{id}
- GET/tasks/{id}/checklist
- POST/tasks/{id}/checklist
- PATCH/tasks/{id}/checklist/{itemId}
- DELETE/tasks/{id}/checklist/{itemId}
- GET/tasks/{id}/subtasks
- POST/tasks/{id}/subtasks
- GET/tasks/{id}/comments
- POST/tasks/{id}/comments
- PATCH/tasks/{id}/comments/{commentId}
- DELETE/tasks/{id}/comments/{commentId}
- GET/tasks/{id}/attachments
- POST/tasks/{id}/attachments
- GET/tasks/{id}/attachments/{attachmentId}
- DELETE/tasks/{id}/attachments/{attachmentId}
- POST/tasks/{id}/toggle
- POST/milestones/{id}/toggle
List projects (paged, filterable)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| search | query | string | |
| page | query | integer | |
| limit | query | integer | |
| status | query | string (open | completed | all) | |
| archived | query | integer (0 | 1) | |
| client_id | query | integer | |
| mine | query | integer (0 | 1) | Only projects managed by the caller |
Example request
curl "https://YOUR-HOST/api/v1/projects" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/projects",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/projects", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/projects");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Paged project list
| Field | Type | Description |
|---|---|---|
| data | array of object | |
| data[].id | integer | |
| data[].prefix | string | |
| data[].number | integer | |
| data[].name | string | |
| data[].due_at | string | |
| data[].created_at | string | |
| data[].completed_at | string | |
| data[].archived_at | string | |
| data[].client | string | |
| data[].manager | string | |
| data[].ticket_count | integer | |
| data[].ticket_closed_count | integer | |
| data[].task_count | integer | |
| data[].task_completed_count | integer | |
| total | integer | |
| page | integer | |
| limit | integer |
Example response
{
"data": [
{
"id": 1,
"prefix": "string",
"number": 1,
"name": "string",
"due_at": "string",
"created_at": "string",
"completed_at": "string",
"archived_at": "string",
"client": "string",
"manager": "string",
"ticket_count": 1,
"ticket_closed_count": 1,
"task_count": 1,
"task_completed_count": 1
}
],
"total": 1,
"page": 1,
"limit": 1
}
Project detail with milestones, tasks and linked tickets
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/projects/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/projects/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/projects/1", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/projects/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Project detail
| Field | Type | Description |
|---|---|---|
| id | integer | |
| prefix | string | |
| number | integer | |
| name | string | |
| description | string | |
| due_at | string | |
| start_at | string | |
| created_at | string | |
| updated_at | string | |
| completed_at | string | |
| archived_at | string | |
| client | string | |
| manager | string | |
| estimated_hours | number | |
| budget_amount | number | |
| hourly_rate | number | |
| milestones | array of object | |
| milestones[].id | integer | |
| milestones[].name | string | |
| milestones[].description | string | |
| milestones[].due_at | string | |
| milestones[].order | integer | |
| milestones[].status | string | |
| milestones[].completed_at | string | |
| tasks | array of object | |
| tasks[].id | integer | |
| tasks[].name | string | |
| tasks[].status | string | |
| tasks[].progress | integer | |
| tasks[].due_at | string | |
| tasks[].start_at | string | |
| tasks[].milestone_id | integer | |
| tasks[].completed_at | string | |
| tasks[].assigned_to | string | |
| tasks[].ticket_number | string | |
| tasks[].priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| tasks[].priority_name | string | |
| tasks[].description | string | Plain text, never HTML |
| tasks[].color | string | Card accent as #rrggbb |
| tasks[].labels | array of object | |
| tasks[].labels[].id | integer | |
| tasks[].labels[].name | string | |
| tasks[].labels[].color | string | |
| tasks[].parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| tasks[].assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| tasks[].assignees[].id | integer | |
| tasks[].assignees[].name | string | |
| tasks[].assignees[].primary | boolean | |
| tasks[].checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| tasks[].checklist.done | integer | |
| tasks[].checklist.total | integer | |
| tasks[].subtasks | object | Subtask progress (database 2.6.208) |
| tasks[].subtasks.done | integer | |
| tasks[].subtasks.total | integer | |
| tasks[].comment_count | integer | |
| tasks[].attachment_count | integer | |
| tasks[].reminder_at | string | One-off reminder time (database 2.6.209) |
| tasks[].reminder_sent_at | string | |
| tasks[].repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| tasks[].repeat.interval | integer | |
| tasks[].repeat.unit | string (day | week | month | year) | |
| tickets | array of object | |
| tickets[].id | integer | |
| tickets[].number | string | |
| tickets[].subject | string | |
| tickets[].status | string | |
| tickets[].status_color | string | |
| tickets[].due_at | string | |
| tickets[].closed_at | string | |
| tickets[].assigned_to | string |
Example response
{
"id": 1,
"prefix": "string",
"number": 1,
"name": "string",
"description": "string",
"due_at": "string",
"start_at": "string",
"created_at": "string",
"updated_at": "string",
"completed_at": "string",
"archived_at": "string",
"client": "string",
"manager": "string",
"estimated_hours": 1.5,
"budget_amount": 1.5,
"hourly_rate": 1.5,
"milestones": [
{
"id": 1,
"name": "string",
"description": "string",
"due_at": "string",
"order": 1,
"status": "string",
"completed_at": "string"
}
],
"tasks": [
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
null
],
"parent_id": 1,
"assignees": [
null
],
"checklist": {
"done": null,
"total": null
},
"subtasks": {
"done": null,
"total": null
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": null,
"unit": "day"
}
}
],
"tickets": [
{
"id": 1,
"number": "string",
"subject": "string",
"status": "string",
"status_color": "string",
"due_at": "string",
"closed_at": "string",
"assigned_to": "string"
}
]
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Create a project task (scope api:tasks:write; project_id and name required)
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| project_id | integer | Create only |
| name | string | |
| status | string (To Do | In Progress | Blocked | Done) | |
| progress | integer | |
| start_at | string (date) | |
| due_at | string (date) | |
| milestone_id | integer | Must belong to the task's project; 0 clears |
| assigned_user_id | integer | An active user; 0 clears |
| estimate_minutes | integer | |
| priority | integer | |
| description | string | |
| color | string | |
| labels | array of string | Label names, or {name, color}; unknown names are created in the task's project; replaces the task's labels ([] clears). |
| label_ids | array of integer | Existing labels that are global or belong to the task's project (others are ignored). |
| parent_id | integer | Make the task a subtask of this task (same project, one level deep, no cycles); null or 0 detaches. On POST the parent is checked before anything is created. |
| assignee_ids | array of integer | Everyone on the task (active users). The current primary stays primary when it is in the list, otherwise the first one becomes it. assigned_user_id alone (older clients) swaps the primary and keeps the rest; 0 clears everyone. |
| reminder_at | string | YYYY-MM-DD HH:MM[:SS]; null clears. Changing the time re-arms a delivered reminder. |
| repeat | object | Repeat rule; null stops repeating. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}'
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
201Created task
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
One task, with priority, description, colour and labels
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Task
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Same as PATCH (only the fields sent change)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| project_id | integer | Create only |
| name | string | |
| status | string (To Do | In Progress | Blocked | Done) | |
| progress | integer | |
| start_at | string (date) | |
| due_at | string (date) | |
| milestone_id | integer | Must belong to the task's project; 0 clears |
| assigned_user_id | integer | An active user; 0 clears |
| estimate_minutes | integer | |
| priority | integer | |
| description | string | |
| color | string | |
| labels | array of string | Label names, or {name, color}; unknown names are created in the task's project; replaces the task's labels ([] clears). |
| label_ids | array of integer | Existing labels that are global or belong to the task's project (others are ignored). |
| parent_id | integer | Make the task a subtask of this task (same project, one level deep, no cycles); null or 0 detaches. On POST the parent is checked before anything is created. |
| assignee_ids | array of integer | Everyone on the task (active users). The current primary stays primary when it is in the list, otherwise the first one becomes it. assigned_user_id alone (older clients) swaps the primary and keeps the rest; 0 clears everyone. |
| reminder_at | string | YYYY-MM-DD HH:MM[:SS]; null clears. Changing the time re-arms a delivered reminder. |
| repeat | object | Repeat rule; null stops repeating. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example request
curl -X PUT "https://YOUR-HOST/api/v1/tasks/1" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}'
import requests
response = requests.put(
"https://YOUR-HOST/api/v1/tasks/1",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1", {
method: "PUT",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Updated task
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Change the fields sent (scope api:tasks:write); PUT behaves the same
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| project_id | integer | Create only |
| name | string | |
| status | string (To Do | In Progress | Blocked | Done) | |
| progress | integer | |
| start_at | string (date) | |
| due_at | string (date) | |
| milestone_id | integer | Must belong to the task's project; 0 clears |
| assigned_user_id | integer | An active user; 0 clears |
| estimate_minutes | integer | |
| priority | integer | |
| description | string | |
| color | string | |
| labels | array of string | Label names, or {name, color}; unknown names are created in the task's project; replaces the task's labels ([] clears). |
| label_ids | array of integer | Existing labels that are global or belong to the task's project (others are ignored). |
| parent_id | integer | Make the task a subtask of this task (same project, one level deep, no cycles); null or 0 detaches. On POST the parent is checked before anything is created. |
| assignee_ids | array of integer | Everyone on the task (active users). The current primary stays primary when it is in the list, otherwise the first one becomes it. assigned_user_id alone (older clients) swaps the primary and keeps the rest; 0 clears everyone. |
| reminder_at | string | YYYY-MM-DD HH:MM[:SS]; null clears. Changing the time re-arms a delivered reminder. |
| repeat | object | Repeat rule; null stops repeating. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example request
curl -X PATCH "https://YOUR-HOST/api/v1/tasks/1" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}'
import requests
response = requests.patch(
"https://YOUR-HOST/api/v1/tasks/1",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1", {
method: "PATCH",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"project_id": 1,
"name": "string",
"status": "To Do",
"progress": 1,
"start_at": "string",
"due_at": "string",
"milestone_id": 1,
"assigned_user_id": 1,
"estimate_minutes": 1,
"priority": 1,
"description": "string",
"color": "#206bc4",
"labels": [
"string"
],
"label_ids": [
1
],
"parent_id": 1,
"assignee_ids": [
1
],
"reminder_at": "2026-11-02 09:00",
"repeat": {
"interval": 1,
"unit": "day"
}
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"project_id":1,"name":"string","status":"To Do","progress":1,"start_at":"string","due_at":"string","milestone_id":1,"assigned_user_id":1,"estimate_minutes":1,"priority":1,"description":"string","color":"#206bc4","labels":["string"],"label_ids":[1],"parent_id":1,"assignee_ids":[1],"reminder_at":"2026-11-02 09:00","repeat":{"interval":1,"unit":"day"}}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Updated task
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Delete a task and its label links (scope api:tasks:delete; Service Desk level 3)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl -X DELETE "https://YOUR-HOST/api/v1/tasks/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.delete(
"https://YOUR-HOST/api/v1/tasks/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1", {
method: "DELETE",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Deleted
| Field | Type | Description |
|---|---|---|
| deleted | boolean | |
| id | integer |
Example response
{
"deleted": true,
"id": 1
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
A task's checklist items (database 2.6.208)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1/checklist" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1/checklist",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/checklist", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/checklist");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Items in order
| Field | Type | Description |
|---|---|---|
| items | array of object | |
| items[].id | integer | |
| items[].text | string | |
| items[].done | boolean |
Example response
{
"items": [
{
"id": 1,
"text": "string",
"done": true
}
]
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
409Update Database has not run yet
Add a checklist item at the end (scope api:tasks:write)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| textrequired | string |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks/1/checklist" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"string"}'
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks/1/checklist",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"text": "string"
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/checklist", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"text": "string"
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/checklist");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"text":"string"}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
201The new item
| Field | Type | Description |
|---|---|---|
| id | integer | |
| text | string | |
| done | boolean |
Example response
{
"id": 1,
"text": "string",
"done": true
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Change an item's text and/or done flag (scope api:tasks:write)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| itemIdrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| text | string | |
| done | boolean |
Example request
curl -X PATCH "https://YOUR-HOST/api/v1/tasks/1/checklist/1" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"text":"string","done":true}'
import requests
response = requests.patch(
"https://YOUR-HOST/api/v1/tasks/1/checklist/1",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"text": "string",
"done": True
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/checklist/1", {
method: "PATCH",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"text": "string",
"done": true
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/checklist/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"text":"string","done":true}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
200The item
| Field | Type | Description |
|---|---|---|
| id | integer | |
| text | string | |
| done | boolean |
Example response
{
"id": 1,
"text": "string",
"done": true
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Delete an item (scope api:tasks:delete)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| itemIdrequired | path | integer |
Example request
curl -X DELETE "https://YOUR-HOST/api/v1/tasks/1/checklist/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.delete(
"https://YOUR-HOST/api/v1/tasks/1/checklist/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/checklist/1", {
method: "DELETE",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/checklist/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200{deleted: true, id}
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
A task's subtasks (database 2.6.208)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1/subtasks" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1/subtasks",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/subtasks", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/subtasks");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Subtasks in order
| Field | Type | Description |
|---|---|---|
| subtasks | array of object | |
| subtasks[].id | integer | |
| subtasks[].name | string | |
| subtasks[].done | boolean |
Example response
{
"subtasks": [
{
"id": 1,
"name": "string",
"done": true
}
]
}
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Create a subtask (scope api:tasks:write). A subtask cannot have subtasks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| namerequired | string |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks/1/subtasks" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string"}'
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks/1/subtasks",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"name": "string"
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/subtasks", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"name": "string"
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/subtasks");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"name":"string"}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
201The new task (its parent_id is this task)
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
A task's comments, oldest first (database 2.6.208)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1/comments" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1/comments",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/comments", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/comments");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Comments
| Field | Type | Description |
|---|---|---|
| comments | array of object | |
| comments[].id | integer | |
| comments[].user_id | integer | |
| comments[].user | string | Author name, or "Former user" |
| comments[].body | string | |
| comments[].created_at | string | |
| comments[].updated_at | string |
Example response
{
"comments": [
{
"id": 1,
"user_id": 1,
"user": "string",
"body": "string",
"created_at": "string",
"updated_at": "string"
}
]
}
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Add a comment as the caller (scope api:tasks:write)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| bodyrequired | string | Plain text (tags are stripped) |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks/1/comments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body":"string"}'
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks/1/comments",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"body": "string"
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/comments", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"body": "string"
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/comments");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"body":"string"}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
201{id}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
Edit a comment (its author only; scope api:tasks:write)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| commentIdrequired | path | integer |
Request body (application/json, required)
| Field | Type | Description |
|---|---|---|
| bodyrequired | string |
Example request
curl -X PATCH "https://YOUR-HOST/api/v1/tasks/1/comments/1" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"body":"string"}'
import requests
response = requests.patch(
"https://YOUR-HOST/api/v1/tasks/1/comments/1",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"body": "string"
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/comments/1", {
method: "PATCH",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"body": "string"
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/comments/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"body":"string"}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
200{id}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Delete a comment (its author, or an administrator; scope api:tasks:delete)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| commentIdrequired | path | integer |
Example request
curl -X DELETE "https://YOUR-HOST/api/v1/tasks/1/comments/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.delete(
"https://YOUR-HOST/api/v1/tasks/1/comments/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/comments/1", {
method: "DELETE",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/comments/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200{deleted: true, id}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Metadata of a task's files (database 2.6.209); never the stored name
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1/attachments" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1/attachments",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/attachments", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/attachments");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Files
| Field | Type | Description |
|---|---|---|
| attachments | array of object | |
| attachments[].id | integer | |
| attachments[].name | string | |
| attachments[].size | integer | |
| attachments[].mime | string | |
| attachments[].uploaded_by | string | |
| attachments[].created_at | string |
Example response
{
"attachments": [
{
"id": 1,
"name": "string",
"size": 1,
"mime": "string",
"uploaded_by": "string",
"created_at": "string"
}
]
}
Attach a file (multipart/form-data, field "file"; scope api:tasks:write). Scripts, web pages and installers are refused; up to 25 MB and 50 files per task.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Request body (multipart/form-data, required)
| Field | Type | Description |
|---|---|---|
| filerequired | string (binary) |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks/1/attachments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"file":"string"}'
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks/1/attachments",
headers={"Authorization": f"Bearer {TOKEN}"},
json={
"file": "string"
},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/attachments", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
body: JSON.stringify({
"file": "string"
}),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/attachments");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
CURLOPT_POSTFIELDS => '{"file":"string"}',
]);
$data = json_decode(curl_exec($ch), true);
Responses
201{id}
400Bad request
| Field | Type | Description |
|---|---|---|
| error | string |
Download a file (always sent as an attachment, application/octet-stream, nosniff)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| attachmentIdrequired | path | integer |
Example request
curl "https://YOUR-HOST/api/v1/tasks/1/attachments/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.get(
"https://YOUR-HOST/api/v1/tasks/1/attachments/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/attachments/1", {
method: "GET",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/attachments/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200The file bytes
Example response
"string"
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Delete a file (the uploader, or Service Desk level 3 / an administrator; scope api:tasks:delete)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer | |
| attachmentIdrequired | path | integer |
Example request
curl -X DELETE "https://YOUR-HOST/api/v1/tasks/1/attachments/1" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.delete(
"https://YOUR-HOST/api/v1/tasks/1/attachments/1",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/attachments/1", {
method: "DELETE",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/attachments/1");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200{deleted: true, id}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Toggle a task's completed state (works for both project-only tasks and ticket-linked tasks)
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl -X POST "https://YOUR-HOST/api/v1/tasks/1/toggle" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/tasks/1/toggle",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tasks/1/toggle", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tasks/1/toggle");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Updated task
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| status | string | |
| progress | integer | |
| due_at | string | |
| start_at | string | |
| milestone_id | integer | |
| completed_at | string | |
| assigned_to | string | |
| ticket_number | string | |
| priority | integer | 0 none, 1 low, 2 medium, 3 high, 4 urgent (database 2.6.207; 0 before the update) |
| priority_name | string | |
| description | string | Plain text, never HTML |
| color | string | Card accent as #rrggbb |
| labels | array of object | |
| labels[].id | integer | |
| labels[].name | string | |
| labels[].color | string | |
| parent_id | integer | The parent task when this is a subtask (database 2.6.208; null before the update and for ordinary tasks) |
| assignees | array of object | Everyone on the task, the primary assignee first (database 2.6.209; before it, only the primary). `assigned_to` stays the primary's name. |
| assignees[].id | integer | |
| assignees[].name | string | |
| assignees[].primary | boolean | |
| checklist | object | Checklist progress (database 2.6.208; zeros before it) |
| checklist.done | integer | |
| checklist.total | integer | |
| subtasks | object | Subtask progress (database 2.6.208) |
| subtasks.done | integer | |
| subtasks.total | integer | |
| comment_count | integer | |
| attachment_count | integer | |
| reminder_at | string | One-off reminder time (database 2.6.209) |
| reminder_sent_at | string | |
| repeat | object | Repeat rule (database 2.6.209); null when the task does not repeat. Completing the task creates the next occurrence with the due date moved on. |
| repeat.interval | integer | |
| repeat.unit | string (day | week | month | year) |
Example response
{
"id": 1,
"name": "string",
"status": "string",
"progress": 1,
"due_at": "string",
"start_at": "string",
"milestone_id": 1,
"completed_at": "string",
"assigned_to": "string",
"ticket_number": "string",
"priority": 1,
"priority_name": "High",
"description": "string",
"color": "#206bc4",
"labels": [
{
"id": 1,
"name": "string",
"color": "string"
}
],
"parent_id": 1,
"assignees": [
{
"id": 1,
"name": "string",
"primary": true
}
],
"checklist": {
"done": 1,
"total": 1
},
"subtasks": {
"done": 1,
"total": 1
},
"comment_count": 1,
"attachment_count": 1,
"reminder_at": "2026-11-02 09:00:00",
"reminder_sent_at": "string",
"repeat": {
"interval": 1,
"unit": "day"
}
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |
Toggle a project milestone's completed state
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | integer |
Example request
curl -X POST "https://YOUR-HOST/api/v1/milestones/1/toggle" \
-H "Authorization: Bearer $TOKEN"
import requests
response = requests.post(
"https://YOUR-HOST/api/v1/milestones/1/toggle",
headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/milestones/1/toggle", {
method: "POST",
headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/milestones/1/toggle");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);
Responses
200Updated milestone
| Field | Type | Description |
|---|---|---|
| id | integer | |
| name | string | |
| description | string | |
| due_at | string | |
| order | integer | |
| status | string | |
| completed_at | string |
Example response
{
"id": 1,
"name": "string",
"description": "string",
"due_at": "string",
"order": 1,
"status": "string",
"completed_at": "string"
}
403Authenticated but not permitted
| Field | Type | Description |
|---|---|---|
| error | string |
404Resource not found
| Field | Type | Description |
|---|---|---|
| error | string |