Tasks
Tasks represent to-do items and action items in your CRM. They can be assigned to employees, linked to relationships, and have start/end dates to track deadlines.
Use the Activity_Task endpoint to manage tasks. Tasks inherit all fields from Activity and add task-specific fields like Assignee, StartDate, and EndDate.
Endpoints
List Tasks
GET
/v1/odata/Activity_TaskSingle Task
GET
/v1/odata/Activity_Task({id})With expanded relations:
GET
/v1/odata/Activity_Task({id})?$expand=Assignee,Relationship,PhaseCreate Task
POST
/v1/odata/Activity_TaskUpdate Task
PUT
/v1/odata/Activity_Task({id})Delete Task
DELETE
/v1/odata/Activity_Task({id})Fields
Task Fields
| Field | Type | Description |
|---|---|---|
Subject | String | Task subject / title |
StartDate | DateTimeOffset | Task start date |
EndDate | DateTimeOffset | Task due date |
Description | String | Task description |
Inherited Fields (from Activity)
See Activity Fields for all inherited fields.
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Assignee | Relationship.Person.Contact.Employee | N:1 | Assigned employee |
| Relationship | Relationship | N:1 | Linked relation |
| Phase | Datastore.Phase.ActivityTask | N:1 | Task phase |
| LinkedActivities | Activity | 1:N | Linked activities |
Expanding Relationships
GET
/v1/odata/Activity_Task({id})?$expand=AssigneeNavigating Relationships
GET
/v1/odata/Activity_Task({id})/AssigneeFiltering Examples
GET
/v1/odata/Activity_Task?$filter=IsClosed eq {IsClosed}&$top={top}GET
/v1/odata/Activity_Task?$filter=contains(Subject, '{Subject}')&$top={top}GET
/v1/odata/Activity_Task?$filter=EndDate lt {EndDate}&$top={top}GET
/v1/odata/Activity_Task?$filter=StartDate gt {StartDate}&$top={top}