References
Tasks Resources
Endpoints
List tasks
Returns a list of tasks
Task ID
Boolean
: Status, done (true) or not done (false)
Assignee user ID
Program ID
Boolean
: Overdue (true) or not overdue (false)
Allowed values: today
, yesterday
, this-week
, last-week
, this-month
, last-month
Allowed values: today
, yesterday
, this-week
, last-week
, this-month
, last-month
Allowed sort fields: created_at
, due_date
200: OK
A paginated list of Task Resource Objects
A paginated list of Task Resource Objects
{
"data": [
{
"id": "...",
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "..."
},
"program": {
"id": "...",
"name": "...",
"created_at": ...
},
"description": "...",
"due": ...,
"done": ...,
"created_at": ...
},
...
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": null
},
"meta": {
"current_page": ...,
"from": ...,
"last_page": ...,
"path": "...",
"per_page": ...,
"to": ...,
"total": ...
}
}
Add a task
Adds a new task to a user on a program
Program ID
Assignee user ID, the user has to be a member on the given program
Description/detail text
String:
Due date (Unix time stamp, any format, relative formats)
String:
It can be high, medium, low or empty
200: OK
Task Response Object
Task Response Object
{
"todo": {
"id": "...",
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "..."
},
"program": {
"id": "...",
"name": "...",
"created_at": ...
},
"description": "...",
"due": ...,
"done": ...,
"priority": "...",
"created_at": ...
}
}
Update a task
Updates a task
Task ID
boolean, mark a task as done or not-done
200: OK
A Task Resource Object
A Task Resource Object
{
"task": {
"id": "...",
"user": {
"avatar": "...",
"email": "...",
"id": "...",
"name": "...",
"timezone": "..."
},
"program": {
"id": "...",
"name": "...",
"created_at": ...
},
"description": "...",
"due": ...,
"done": ...,
"created_at": ...
}
}
Resource Objects
Task
Property | Type | Description |
---|---|---|
id | string | Task ID |
user | Assignee user | |
program | Program | |
title | string | Title |
description | string | Description/detail |
due | integer | null | Due date (Unix timestamp) |
done | boolean | Status (done or not) |
priority | string | Priority value ( high, medium, low or empty ) |
recurring | boolean | Whether the task is a recurring one or not |
recurrence_type | string | If the task is a recurring task, one of the following values: daily, every-weekday, weekly-on-day, bi-weekly-on-day, monthly-on-first-day, monthly-on-second-day, monthly-on-third-day, monthly-on-fourth-day, monthly-on-last-day, every-3-months-on-first-day, every-6-months-on-first-day, annually-on-date, custom |
recurrence_pattern | object | Custom recurrence pattern configuration, only if recurrence_type is custom |
created_at | integer | Created date and time (Unix timestamp) |