Tasks
Query, create, update and delete the tasks.
Table Specific Information
Select
- Id supports the '=' operator.
- IsCleared supports the '=' operator.
- IsAlarmCleared supports the '=' operator.
- IsAlarmed supports the '=' operator.
- OriginalTime supports the '<=,<,=,!=,>,>=' operator.
- StartTime supports the '<=,<,=,!=,>,>=' operator.
- EndTime supports the '<=,<,=,!=,>,>=' operator.
- IsTimeless supports the '=' operator.
- IsAllDay supports the '=' operator.
- IsPrivate supports the '=' operator.
- AttachmentLastModified supports the '<=,<,=,!=,>,>=' operator.
- AttachmentPersonal supports the '=' operator.
- Subject supports the '<=,<,=,!=,>,>=,CONTAINS' operator.
- Created supports the '<=,<,=,!=,>,>=' operator.
- Edited supports the '<=,<,=,!=,>,>=' operator.
SELECT * FROM Tasks WHERE Id = '12345' SELECT * FROM Tasks WHERE Subject = 'Follow up call'
Insert
To insert a task, you must specify at least one contact, start time and end time.
INSERT INTO Tasks (ActivityTypeName, StartTime, EndTime, ContactsAggregate) VALUES ('To-Do', '2026-01-15T09:00:00', '2026-01-15T09:30:00', '[{\"id\":\"972df268-a4db-41db-bc32-4af89ab3034b\"}]')
Update
Any column where ReadOnly=False can be updated. Specify the Task Id when updating a task.
UPDATE Tasks SET Details = 'abc' WHERE Id = '2a82a5c3-c380-47a4-8b52-0eb003405def01152026'
Delete
Tasks can be deleted by providing an Id and issuing a DELETE statement.
DELETE FROM Tasks WHERE Id = 'dc75eaa5-c651-4118-93fc-0a4360458ec807022026'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier that represents the task. |
| SeriesID | String | True |
A unique identifier that represents the activity. The id returned is based on whether it is recurring or not: RecurSourceActivityId or ActivityID. |
| IsCleared | Boolean | True |
Indicates that the task has been cleared. |
| IsAlarmCleared | Boolean | True |
Boolean value of IsAlarmCleared. |
| IsAlarmed | Boolean | False |
Turns on/off an alarm for this task. |
| LeadMinutes | Integer | False |
The number of minutes the alarm will sound before the task is scheduled to start. |
| AlarmDue | String | True |
Alarm due. |
| OriginalTime | Datetime | False |
The date and time for which this task was originally scheduled. |
| StartTime | Datetime | False |
The time the task is to begin. |
| EndTime | Datetime | False |
The time the task is to end. |
| Duration | String | True |
The difference between the start time and end time of the task. |
| ExternalId | String | False |
Provides a unique identifier to an external system. |
| CalendarUid | String | False |
A unique calendar uid, common for all invited users. |
| AccessorId | String | False |
The unique id of the activity accessor. |
| Location | String | False |
Describes the physical location that the task is to take place. |
| IsTimeless | Boolean | False |
Indicates whether a specified task is to be completed at a specific time-of-day. |
| IsAllDay | Boolean | False |
Indicates whether the task takes up an entire day. |
| IsPrivate | Boolean | False |
Indicates elevated security that only the creator/owner has access to this task. |
| IsRecurring | Boolean | True |
True if the task is recurring, otherwise false. |
| RecurSpecSeriesStart | Datetime | True |
The start date and time of the recurring task series. |
| RecurSpecSeriesEnd | Datetime | True |
The end date and time of the recurring task series. |
| RecurSpecIsEndless | Boolean | True |
Indicates whether the recurring task series has no end date. |
| RecurSpecMonth | Integer | True |
The month component of the recurrence schedule. |
| RecurSpecFrequency | Integer | True |
The frequency of the recurrence. |
| RecurSpecRecurType | String | True |
The type of recurrence (e.g., None, Daily, Weekly, Monthly). |
| RecurSpecDayDayAsInt | Integer | True |
The day of the recurrence as an integer. |
| RecurSpecDayDaysOfWeek | String | True |
The days of the week for the recurrence. |
| RecurSpecDayTypedDay | String | True |
The typed day of the recurrence. |
| RecurSpecDayDayType | String | True |
The day type of the recurrence. |
| RecurSpecDayOrdinal | String | True |
The ordinal position of the day in the recurrence (e.g., First, Second, Last). |
| ActivityPriorityId | Integer | False |
Activity priority value. |
| ActivityPriorityName | String | False |
Displays the priority of the task. |
| ActivityTypeId | Integer | True |
Displays the id of the type of the activity. |
| ActivityTypeName | String | False |
Displays the type of the task. |
| AttachmentDisplayName | String | True |
Gets presentation name of the attachment. |
| AttachmentFileExtension | String | True |
Gets the extension of the attachment. |
| AttachmentFileName | String | True |
Gets a string representing the attachment full path. |
| AttachmentFileSize | Integer | True |
Gets the size (bytes) of the attachment. |
| AttachmentFileSizeDisplay | String | True |
Gets the displayable text representation of the attachment. |
| AttachmentFileType | String | True |
Gets the registered system file type name of the attachment. |
| AttachmentLastModified | Datetime | True |
Gets the last modified date of the attachment. |
| AttachmentPersonal | Boolean | True |
Indicates whether the attachment is bound for the personal supplemental files or the workgroup supplemental files. |
| BannerColor | String | False |
The banner color. |
| Details | String | False |
Additional detailed information about the task. |
| Subject | String | False |
A description of the action to be completed. |
| Created | Datetime | True |
The date and time the task was created. |
| Edited | Datetime | True |
The date and time the task was last updated. |
| ScheduledById | String | False |
The id of the task organizer. |
| ScheduledBy | String | True |
The contact who created this task. |
| ScheduledForId | String | False |
The id of the task organizer. |
| ScheduledFor | String | False |
The name of the task organizer. |
| ScheduledWithCompany | String | True |
Company name of the contact with whom this task was scheduled. |
| ScheduledWithEmail | String | True |
Business email address of the contact with whom this task was scheduled. |
| ScheduledWithPhone | String | True |
Phone number of the contact with whom this task was scheduled. |
| ScheduledWithPhoneExt | String | True |
Phone extension of the contact with whom this task was scheduled. |
| CompaniesAggregate | String | False |
List of companies that are associated to this task. |
| ContactsAggregate | String | False |
List of contacts that are associated to this task. At least one contact is required. |
| GroupsAggregate | String | False |
List of groups that are associated to this task. |
| OpportunitiesAggregate | String | False |
List of opportunities that are associated to this task. |