About Tasks
The Tasks API allows you to create and manage tasks. You can organize and prioritize daily task activities, such as follow up calls and emails, or scheduling meetings.
With Tasks you can:
- Create, update, and delete tasks.
- Link tasks to a contact.
- Create reminder notifications by setting a due date for tasks.
- Prioritize tasks by adjusting their display order.
- Retrieve tasks.
- Count how many tasks you have based on specified filters.
Task reminders
When you set a due date for a task, reminder notifications are sent on:
- The day before the due date.
- The due date.
Reminder notifications are not sent for overdue tasks.
CRM Tasks: Supported Filters and Sorting
The following table shows field support for filters and sorting for the task object:
Field | Supported Filters | Sortable |
---|---|---|
id | $eq , $ne , $in | Sortable |
createdDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
updatedDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
dueDate | $eq , $ne , $gt , $lt , $gte , $lte | Sortable |
status | $eq , $ne , $in , $nin | |
contact.id | $eq , $ne , $in , $exists |
Related content: API Query Language, Query Tasks
The task
object represents all information available for tasks. A task is a specific action or assignment to be completed.
Creates a new task.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a task by ID.
Permission Scopes
For app development, you must have one of the following permission scopes:Deletes a task by ID.
Permission Scopes
For app development, you must have one of the following permission scopes:Updates a task.
Each time the task is updated, revision
increments by 1.
The existing revision
must be included when updating the task.
This ensures you're working with the latest task
and prevents unintended overwrites.
Permission Scopes
For app development, you must have one of the following permission scopes:Retrieves a list of tasks, given the provided paging, filtering, and sorting.
Query Tasks runs with the following defaults, which you can override:
_createdDate
inDESC
order
For field support for filters and sorting, see Tasks: Supported Filters and Sorting.
To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.
Permission Scopes
For app development, you must have one of the following permission scopes:Counts the number of tasks.
This endpoint returns the count of all tasks regardless of the task status
.
Optionally, you can pass a filter to count only tasks based on specified criteria.
Permission Scopes
For app development, you must have one of the following permission scopes:Moves a task specified by ID to be placed after another task in the display.
You can reposition a task to be first in the display by ommitting beforeTaskId
.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a task reaches its due date.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a task is created.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a task is updated.
Permission Scopes
For app development, you must have one of the following permission scopes:Triggered when a task is deleted.