tasks
GET /api/tasks
Summary: List tasks
You can filter tasks using parameters specified below. For any filter field that can get multiple options, you can specify them using comma-separated string (this will return all tasks belonging to user 1 OR user 2)
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| query | owner |
array | no | Multiple values may be separated by commas. |
| query | assigned_to |
string | no | Filter by assigned to. |
| query | title |
string | no | Filter by name. |
| query | is_open |
boolean | no | Filter opened tasks |
| query | is_overdue |
boolean | no | Filter overdue tasks |
| query | unassigned |
boolean | no | Filter unassigned tasks |
| query | ordering |
string | no | Which field to use when ordering the results. |
| query | page |
integer | no | A page number within the paginated result set. |
| query | page_size |
integer | no | Number of results to return per page. |
Responses
-
200 —
-
Media type:
application/json
Type: PaginatedTaskList
POST /api/tasks
Summary: Create a new task
Request Body
- Media type:
application/json
Type: Task
- Media type:
application/x-www-form-urlencoded
Type: Task
- Media type:
multipart/form-data
Type: Task
Responses
-
200 —
-
Media type:
application/json
Type: Task
DELETE /api/tasks/{id}
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this task. |
Responses
- 204 — No response body
GET /api/tasks/{id}
Summary: Get details for specified task
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this task. |
Responses
-
200 —
-
Media type:
application/json
Type: Task
PATCH /api/tasks/{id}
Summary: Update specified task settings
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this task. |
Request Body
- Media type:
application/json
Type: PatchedTask
- Media type:
application/x-www-form-urlencoded
Type: PatchedTask
- Media type:
multipart/form-data
Type: PatchedTask
Responses
-
200 —
-
Media type:
application/json
Type: Task
PUT /api/tasks/{id}
Summary: Replace specified task
Parameters
| In | Name | Type | Required | Description |
|---|---|---|---|---|
| path | id |
integer | yes | A unique integer value identifying this task. |
Request Body
- Media type:
application/json
Type: Task
- Media type:
application/x-www-form-urlencoded
Type: Task
- Media type:
multipart/form-data
Type: Task
Responses
-
200 —
-
Media type:
application/json
Type: Task