get
https://api.marketcircle.net/v1/tasks/
List the details of a task
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Task Attributes
| Attribute Name | Type | Description | Attributes |
|---|---|---|---|
self | reference | URL of the Task | Read-only Non-null |
title | string | Title of the task (max 512 characters) | Read-Write Non-null Required Searchable |
details | string | Details (max 2048 characters) | Read-Write Nullable Searchable |
category | string | Category name | Read-Write Nullable Searchable |
keywords | array of string | List of Keywords (max 64) | Read-Write Nullable Searchable |
due | datetime | When the task is due | Read-Write Nullable Searchable |
location | string | Location (max 2048 characters) | Read-Write Nullable Searchable |
type | string | The type of the task. See task types for valid values | Read-Write Non-null Default value is "todo"Searchable |
status | string | The status of the task. See task statuses for valid values | Read-Write Non-null Default value is "open"Searchable |
priority | string | The priority of the task: "no_priority", "low", "medium" or "high" | Read-Write Non-null Default value is "no_priority"Searchable |
started | datetime | When the task was started. Must not be after completed | Read-Write Nullable Searchable |
completed | datetime | When the task was completed | Read-Write Nullable Searchable |
estimated_time | integer | Estimated time to complete the task, in seconds | Read-Write Nullable Searchable |
subtasks | array of reference | URLs of the Tasks that are subtasks of this task. See Subtasks | Read-Write Nullable |
parent_task | reference | URL of the Task this task is a subtask of | Read-Write Nullable |
appointments | array of link | Linked Appointments | Read-Write Nullable Searchable |
contacts | array of link | Linked Contacts | Read-Write Nullable Searchable |
companies | array of link | Linked Companies | Read-Write Nullable Searchable |
groups | array of link | Linked Groups | Read-Write Nullable Searchable |
notes | array of link | Linked Notes | Read-Write Nullable Searchable |
forms | array of link | Linked Forms | Read-Write Nullable Searchable |
opportunities | array of link | Linked Opportunities | Read-Write Nullable Searchable |
projects | array of link | Linked Projects | Read-Write Nullable Searchable |
owner | reference | URL of the User responsible for the task | Read-Write Non-null Default value is the user making the request Searchable |
creator | reference | URL of the User that created the task | Read-only Non-null Searchable |
trashed | boolean | Whether the task is in the trash. Set to false to restore it | Read-only Non-null |
create_date | datetime | When the task was created | Read-only Non-null Searchable |
modify_date | datetime | When the task was last updated | Read-only Non-null Searchable |
Task types
"todo" | A to do |
"inbound_call" | An inbound call |
"outbound_call" | An outbound call |
"fax" | A fax |
"email" | An email |
"mail" | A physical mailing |
"print" | A printing |
Task statuses
"open" | The task is still active |
"pending" | The task is pending |
"deferred" | The task has been deferred |
"in_progress" | The task is in progress |
"done" | The task has been completed |
"cancelled" | The task has been cancelled |
Subtasks
A task can have up to 32 subtasks, nested at most 5 levels deep.
- To make a task a subtask, set its
parent_task, or add it to the parent with{"subtasks": {"add": ["/v1/tasks/2001"]}}. - To detach a subtask, set its
parent_tasktonull.
When subtasks are added, the parent's status becomes done if every subtask is done, and open otherwise. A task whose parent is done is marked done when it is attached.
Moving a task to the trash also moves its subtasks to the trash. Restoring the parent does not restore subtasks that are in the trash.