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.

Was this helpful?
Yes
No

CRM Tasks: Supported Filters and Sorting

The following table shows field support for filters and sorting for the task object:

FieldSupported FiltersSortable
id$eq, $ne, $inSortable
createdDate$eq, $ne, $gt, $lt, $gte, $lteSortable
updatedDate$eq, $ne, $gt, $lt, $gte, $lteSortable
dueDate$eq, $ne, $gt, $lt, $gte, $lteSortable
status$eq, $ne, $in, $nin
contact.id$eq, $ne, $in, $exists

Related content: API Query Language, Query Tasks

Was this helpful?
Yes
No

Task Object

The task object represents all information available for tasks. A task is a specific action or assignment to be completed.

Properties
idstringRead-onlyformat GUID
Task ID.

revisionintegerRead-onlyformat int64
Revision number, which increments by 1 each time the task is updated. To prevent conflicting changes, the existing revision must be used when updating a task.

titlestringminLength 1maxLength 250
Title of the task.

descriptionstringminLength 1maxLength 500
Description of the task.

createdDatestringRead-onlyformat date-time
Date and time the task was created.

updatedDatestringRead-onlyformat date-time
Date and time the task was last updated.

dueDatestringformat date-time
Due date for the task.

statusstring
3 enum supported values:
UNKNOWN_STATUSACTION_NEEDEDCOMPLETED
Status of the task.

sourceobject
Details about the task source.

contactobject
Information about the contact associated with the task.
Was this helpful?
Yes
No

PostCreate Task

Creates a new task.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Tasks
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/crm/tasks/v2/tasks

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Task

Retrieves a task by ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/crm/tasks/v2/tasks/{taskId}

Was this helpful?
Yes
No

DeleteDelete Task

Deletes a task by ID.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Tasks
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/crm/tasks/v2/tasks/{taskId}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Task

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:
Manage Tasks
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/crm/tasks/v2/tasks/{task.id}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostQuery Tasks

Retrieves a list of tasks, given the provided paging, filtering, and sorting.

Query Tasks runs with the following defaults, which you can override:

  • _createdDate in DESC 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:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/crm/tasks/v2/tasks/query

Was this helpful?
Yes
No

PostCount Tasks

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:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/crm/tasks/v2/tasks/count

Was this helpful?
Yes
No

PostMove Task After

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:
Manage Tasks
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/crm/tasks/v2/tasks/{taskId}/move-after

Was this helpful?
Yes
No

Task Overdue

Triggered when a task reaches its due date.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.crm.tasks.v2.task.

slugstring
Event name. Expected task_overdue.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

actionEventobject
Event information.

Was this helpful?
Yes
No

Task Created

Triggered when a task is created.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.crm.tasks.v2.task.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.

Was this helpful?
Yes
No

Task Updated

Triggered when a task is updated.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.crm.tasks.v2.task.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.

Was this helpful?
Yes
No

Task Deleted

Triggered when a task is deleted.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Tasks
Manage Tasks
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.crm.tasks.v2.task.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.

Was this helpful?
Yes
No