Person management
Journal management
API documentation
Account management
Persons
Journal
Tasks linked to a person
Table of contents
This endpoint lets you manage tasks for a person.
Tasks help you track things you need to do related to a person. Each task can be assigned a category to help organize them.
Get the list of tasks
This endpoint gets the list of tasks for a specific person.
Tasks are ordered by creation date, with the most recent first.
URL parameters
The ID of the person.
Query parameters
No query parameters are available for this endpoint.
Response attributes
The ID of the task.
The object type. Always 'task'.
The name of the task.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The date the task was completed, in Unix timestamp format.
A subset of the Task category object linked to the task.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": [
{
"id":
1
,
"object":
"task"
,
"name":
"Call mom"
,
"is_completed":
false
,
"due_at":
1715145600
,
"completed_at":
1731143600
,
"task_category": {
"id":
1
,
"name":
"Personal"
,
"color":
"#000000"
,
},
"created_at":
1715145600
,
"updated_at":
1715145600
}
]
}
Create a new task
This endpoint creates a new task for a specific person. It will return the task in the response.
URL parameters
The ID of the person.
Query parameters
The name of the task. Maximum 255 characters.
The date the task is due, in ISO 8601 format (YYYY-MM-DD).
The ID of the task category object.
Response attributes
The ID of the task.
The object type. Always 'task'.
The name of the task.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The date the task was completed, in Unix timestamp format.
A subset of the Task category object linked to the task.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"task"
,
"name":
"Call mom"
,
"is_completed":
false
,
"due_at":
1715145600
,
"completed_at":
1731143600
,
"task_category": {
"id":
1
,
"name":
"Personal"
,
"color":
"#000000"
,
},
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Get a specific task
This endpoint retrieves a specific task for a person.
Parameters
The ID of the person.
The ID of the task.
Response attributes
The ID of the task.
The object type. Always 'task'.
The name of the task.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The date the task was completed, in Unix timestamp format.
A subset of the Task category object linked to the task.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"task"
,
"name":
"Call mom"
,
"is_completed":
false
,
"due_at":
1715145600
,
"completed_at":
1731143600
,
"task_category": {
"id":
1
,
"name":
"Personal"
,
"color":
"#000000"
,
},
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Update a task
This endpoint updates a specific task for a person. It will return the updated task in the response.
Parameters
The ID of the person.
The ID of the task.
The name of the task. Maximum 255 characters.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The ID of the task category.
Response attributes
The ID of the task.
The object type. Always 'task'.
The name of the task.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The date the task was completed, in Unix timestamp format.
A subset of the Task category object linked to the task.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
{
"data": {
"id":
1
,
"object":
"task"
,
"name":
"Call mom"
,
"is_completed":
false
,
"due_at":
1715145600
,
"completed_at":
1731143600
,
"task_category": {
"id":
1
,
"name":
"Personal"
,
"color":
"#000000"
,
},
"created_at":
1715145600
,
"updated_at":
1715145600
}
}
Delete a task
This endpoint deletes a specific task for a person. It will return a 204 No Content response.
Parameters
The ID of the person.
The ID of the task.
Response attributes
This endpoint returns a 204 No Content response with no body.
204 No Content
Toggle a task
This endpoint marks a task as completed or not completed, depending on its current state. It will return the updated task in the response.
Parameters
The ID of the task.
Response attributes
The ID of the task.
The object type. Always 'task'.
The name of the task.
Whether the task is completed.
The date the task is due, in Unix timestamp format.
The date the task was completed, in Unix timestamp format.
A subset of the Task category object linked to the task.
The date and time the object was created, in Unix timestamp format.
The date and time the object was last updated, in Unix timestamp format.
"id":
1
,
"object":
"task"
,
"name":
"Call mom"
,
"is_completed":
false
,
"due_at":
1715145600
,
"completed_at":
1731143600
,
"task_category": {
"id":
1
,
"name":
"Personal"
,
"color":
"#000000"
,
},
"created_at":
1715145600
,
"updated_at":
1715145600
Please login to vote.
It's free and will help us improve the page.
Taylor will be proud of you.
Last updated on April 5, 2025.