/tasks/{id}

GET

/crm/v1/tasks/:id

GET

/api/crm/v1/tasks/:id

$ curl -G https://api.merge.dev/api/crm/v1/tasks/id \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d expand=account

200Retrieved

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   "task_url": "https://crm.example.com/tasks/19202938",
16   "remote_was_deleted": true,
17   "field_mappings": {
18     "organization_defined_targets": {
19       "custom_key": "custom_value"
20     },
21     "linked_account_defined_targets": {
22       "custom_key": "custom_value"
23     }
24   },
25   "remote_data": [
26     {
27       "path": "/tasks",
28       "data": null
29     }
30   ],
31   "remote_fields": [
32     {
33       "remote_field_class": {
34         "id": "string",
35         "display_name": "string",
36         "remote_key_name": "string",
37         "description": "string",
38         "is_custom": true,
39         "is_common_model_field": true,
40         "is_required": true,
41         "field_type": "string",
42         "field_format": "string",
43         "field_choices": [
44           "string"
45         ],
46         "item_schema": {
47           "item_type": "string",
48           "item_format": "string",
49           "item_choices": [
50             "string"
51           ]
52         }
53       },
54       "value": "string"
55     }
56   ]
57 }

Returns a Task object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

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

Allowed values:

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

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only

The datetime that this object was created by Merge.

modified_atdatetimeOptionalRead-only

The datetime that this object was modified by Merge.

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.

task_urlstring or nullOptionalformat: "uri"<=2000 characters

The task's URL in the remote system.

remote_was_deletedbooleanOptionalRead-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 nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only