/tasks/{id}

Returns a Task object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

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

idstring or nullRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetime or nullRead-only

The datetime that this object was created by Merge.

modified_atdatetime or nullRead-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

The task's status. * `OPEN` - OPEN * `CLOSED` - CLOSED

Allowed values:

remote_was_deletedboolean or nullRead-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 objects or nullRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

contactstring or nullOptionalformat: "uuid"

The task's contact.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

subjectstring or nullOptional

The task's subject.

contentstring or nullOptional

The task's content.

ownerstring or nullOptionalformat: "uuid"

The task's owner.

accountstring or nullOptionalformat: "uuid"

The task's account.

opportunitystring or nullOptionalformat: "uuid"

The task's opportunity.

completed_datedatetime or nullOptional

When the task is completed.

due_datedatetime or nullOptional

When the task is due.

statusenum or nullOptional

The task’s status.

OPEN - OPEN
CLOSED - CLOSED

Allowed values:

remote_datalist of objects or nullOptionalRead-only

1	import { MergeClient } from "@mergeapi/merge-node-client";
2
3	const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
4	await client.crm.tasks.retrieve("id", {
5	includeRemoteData: true,
6	includeRemoteFields: true,
7	includeShellData: true
8	});

1	{
2	"id": "550e8400-e29b-41d4-a716-446655440000",
3	"remote_id": "19202938",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"subject": "Contact about Integration Strategy",
7	"content": "Follow up to see whether they need integrations",
8	"owner": "0358cbc6-2040-430a-848e-aafacbadf3aa",
9	"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
10	"opportunity": "550e8400-e29b-41d4-a716-446655440000",
11	"contact": "025fjlc6-6000-430a-848e-aafacbadf4fe",
12	"completed_date": "2022-02-11T00:00:00Z",
13	"due_date": "2022-02-10T00:00:00Z",
14	"status": "OPEN",
15	"remote_was_deleted": true,
16	"field_mappings": {
17	"organization_defined_targets": {
18	"custom_key": "custom_value"
19	},
20	"linked_account_defined_targets": {
21	"custom_key": "custom_value"
22	}
23	},
24	"remote_data": [
25	{
26	"path": "/tasks"
27	}
28	],
29	"remote_fields": [
30	{
31	"remote_field_class": {
32	"id": "string",
33	"display_name": "string",
34	"remote_key_name": "string",
35	"description": "string",
36	"is_custom": true,
37	"is_common_model_field": true,
38	"is_required": true,
39	"field_type": "string",
40	"field_format": "string",
41	"field_choices": [
42	"string"
43	],
44	"item_schema": {
45	"item_type": "string",
46	"item_format": "string",
47	"item_choices": [
48	"string"
49	]
50	}
51	},
52	"value": "string"
53	}
54	]
55	}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration

Field support by integration