Task

List the details of a task

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Task Attributes

Attribute NameTypeDescriptionAttributes
selfreferenceURL of the TaskRead-only
Non-null
titlestringTitle of the taskRead-Write
Nullable
detailsstringDetails of the taskRead-Write
Nullable
categorystringCategory nameRead-Write
Nullable
keywordsarray of stringList of KeywordsRead-Write
Nullable
duedatetimeTimestamp for when the task is dueRead-Write
Nullable
locationstringLocation of the taskRead-Write
Nullable
typestringThe type of the task

See task types for valid values
Read-Write
Non-null
Default value is "todo"
statusstringThe status of the task

See task statuses for valid values
Read-Write
Non-null
Default value is "open"
prioritystringThe priority of the task. Can be 'low', 'medium', or 'high'.Read-Write
Nullable
starteddatetimeTimestamp for when the task startsRead-Write
Nullable
completeddatetimeTimestamp for when the task endsRead-Write
Nullable
estimated_timeintegerEstimated time to complete the task in secondsRead-Write
Nullable
subtasksarray of taskList of Task for which this task is the parent.Read-Write
Nullable
parent_taskreferenceURL of the Task which is the parent of this task.Read-Write
Nullable
appointmentsreferenceURLs of the linked AppointmentsRead-Write
Nullable
contactsreferenceURLs of the linked ContactsRead-Write
Nullable
companiesreferenceURLs of the linked CompaniesRead-Write<
Nullable
groupsreferenceURLs of the linked GroupsRead-Write
Nullable
notesreferenceURLs of the linked NotesRead-Write
Nullable
formsreferenceURLs of the linked FormsRead-Write
Nullable
opportunitiesreferenceURLs of the linked OpportunitiesRead-Write
Nullable
projectsreferenceURLs of the linked ProjectsRead-Write
Nullable
ownerreferenceURL of the User that is responsible for the taskRead-Write
Non-null
creatorreferenceURL of the User that created the taskRead-only
Non-null
trashedbooleanIs the item in the trashRead-Write
Non-null
create_datetimestampTimestamp from when the task was createdRead-only
Non-null
modify_datetimestampTimestamp from when the task was last updatedRead-only
Non-null

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
Path Params
int32
required

The task identifier

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json