Common ModelsTasks

/tasks/{id}

Returns a Task object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
subjectstring or null
The task's subject.
contentstring or null
The task's content.
ownerstring or nullformat: "uuid"
The task's owner.
accountstring or nullformat: "uuid"
The task's account.
opportunitystring or nullformat: "uuid"
The task's opportunity.
contactstring or nullformat: "uuid"
The task's contact.
completed_datedatetime or null
When the task is completed.
due_datedatetime or null
When the task is due.
statusenum or null
The task's status. * `OPEN` - OPEN * `CLOSED` - CLOSED
Allowed values:
remote_was_deletedbooleanRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

field_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only
remote_fieldslist of objectsRead-only