API / V1

Tasks

8 endpoints in this section.

GET/api/v1/projects/{projectId}/tasks

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
status	string	Yes	Current status value for filtering or updates.	DRAFT, TODO, IN_PROGRESS, REVIEW, TESTING, DONE, BLOCKED, ON_HOLD
page	number	No	Page number for paginated results.	-
pageSize	number	No	Number of items returned per page.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

POST/api/v1/projects/{projectId}/tasks

Create Task

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
title	string	Yes	Main title of the resource.	-
description	string	No	Short textual description.	-
status	string	No	Current status value for filtering or updates.	DRAFT, TODO, IN_PROGRESS, REVIEW, TESTING, DONE, BLOCKED, ON_HOLD
priority	string	No	Priority level used for ordering work.	LOW, MEDIUM, HIGH, URGENT
type	string	Yes	Domain category/type of the item.	FEATURE, TESTS, BUG_FIX, UI_UPDATE, PERFORMANCE_UPLIFT, INVESTIGATION
bugSeverity	string	No	Severity level when task type is BUG_FIX. Task's bug severity passed value is ignored (remains null) unless the task type is BUG_FIX.	LOW, MODERATE, HIGH, CRITICAL, FATAL
assignedToId	string	No	User ID assigned to this task.	-
dueDate	string (date)	No	Expected completion date (ISO date).	-
estimatedHours	number	No	Estimated effort in hours.	-

Security Warning:

Task's bug severity passed value is ignored (remains null) unless the task type is BUG_FIX.

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

GET/api/v1/projects/{projectId}/tasks/{taskId}

Fetch Task's Details

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
taskId	string	Yes	Unique identifier of the task.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

PATCH/api/v1/projects/{projectId}/tasks/{taskId}

Update Task

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
taskId	string	Yes	Unique identifier of the task.	-
title	string	No	Main title of the resource.	-
description	string	No	Short textual description.	-
status	string	No	Current status value for filtering or updates.	DRAFT, TODO, IN_PROGRESS, REVIEW, TESTING, DONE, BLOCKED, ON_HOLD
priority	string	No	Priority level used for ordering work.	LOW, MEDIUM, HIGH, URGENT
type	string	No	Domain category/type of the item.	FEATURE, TESTS, BUG_FIX, UI_UPDATE, PERFORMANCE_UPLIFT, INVESTIGATION
bugSeverity	string	No	Severity level when task type is BUG_FIX. bugSeverity is ignored (remains null) unless task type is BUG_FIX.	LOW, MODERATE, HIGH, CRITICAL, FATAL, null
assignedToId	string	No	User ID assigned to this task.	-
dueDate	string (date)	No	Expected completion date (ISO date).	-
estimatedHours	number	No	Estimated effort in hours.	-

Security Warning:

At least one field is required.

bugSeverity is ignored (remains null) unless task type is BUG_FIX.

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

DELETE/api/v1/projects/{projectId}/tasks/{taskId}

Delete Task

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
projectId	string	Yes	Unique identifier of the project.	-
taskId	string	Yes	Unique identifier of the task.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

GET/api/v1/tasks/{taskId}/github/pull-requests

List Task's Pull Requests

Requires read scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
taskId	string	Yes	Unique identifier of the task.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

POST/api/v1/tasks/{taskId}/github/pull-requests

Link Pull Request to Task

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
taskId	string	Yes	Unique identifier of the task.	-
repositoryFullName	string	Yes	Repository in owner/repo format.	-
pullNumber	number	Yes	GitHub pull request number.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.

DELETE/api/v1/tasks/{taskId}/github/pull-requests/{pullRequestId}

Unlink Pull Request from Task

Requires write scope with session_or_bearer authentication.

Parameters

Param	Type	Required	Description	Options
taskId	string	Yes	Unique identifier of the task.	-
pullRequestId	string	Yes	Linked pull request record ID.	-

Request Example

Use the snippet below to call this endpoint from your app or CLI.

Response Example

Toggle between a success and failure payload returned by this endpoint.