/engagement-types/{id}

GET

/crm/v1/engagement-types/:id

GET

/api/crm/v1/engagement-types/:id

1 curl https://api.merge.dev/api/crm/v1/engagement-types/id \
2      -H "X-Account-Token: X-Account-Token" \
3      -H "Authorization: Bearer <token>"

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   "activity_type": "CALL",
7   "name": "First Call",
8   "remote_fields": [
9     {
10       "remote_field_class": {
11         "id": "string",
12         "display_name": "string",
13         "remote_key_name": "string",
14         "description": "string",
15         "is_custom": true,
16         "is_common_model_field": true,
17         "is_required": true,
18         "field_type": "string",
19         "field_format": "string",
20         "field_choices": [
21           "string"
22         ],
23         "item_schema": {
24           "item_type": "string",
25           "item_format": "string",
26           "item_choices": [
27             "string"
28           ]
29         }
30       },
31       "value": "string"
32     }
33   ]
34 }

Returns an EngagementType object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

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.

activity_typeenum or null

The engagement type's activity type. * `CALL` - CALL * `MEETING` - MEETING * `EMAIL` - EMAIL

Allowed values:

namestring or null

The engagement type's name.

remote_fieldslist of objects or nullRead-only

<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA9WYb2/TMBDGv0rll1XasJUOVgmh0g66oWSjzQYDTdHVuSZundiznXYt4rujpH/YYEKweZS+TOR7bP/83F2cr4SCwVioOWkRqlLikFREyEmLHGUxxJhiZoK5ROIQkMyHFJcDw+k+cYjOpRTKYPSWIY90T+GItIibooqxlmdsxDByqUpdlhmMFRgmMu1uomqjMow4hLNsglGbUpFn5jc6y3E1WA786VG7nGlDHCJBa5MokcdJH69z1L+TLFbDy30Cr0VgwL0VXlPL+PveFeuOkKPBqAsGumiQFhtcTZUYI3XLdRPksl5OW49w6mLmgjKMctRus3G4/+KwWVuplLO/DmP+aq86vh6K4YtqGFMeQl71AnrjB8czfxw/9zvPb/zFedNfTBb+ePKsGsZQ9QKveRpcNk677b3TewaEg4NPhxdvum9O/CpdHDX88eXMD+ieF9DJcHHcOHlHZye9Dzf+4nLf6543/OCoefJO7J12+trr9IXXrteJQ26fI2l9+Xr7xcocbUqRi7tjj1OI8RaT5SmAZDWZDzmjdd2oQwoLkcFM16lI3RQjBu4ZBzMSKoVSM9TXOSisyyxeo2ci23AvPOv32n7nqHvXA+0pMA5DjqRlVI6/2Ja0vhCghk2ZmYdmaXbcuJ84JCt2duWQ4uCZwugMFKRoUBWhV9+c+zEYNsUOpBJYnNnBcVdzjWMsdwBHB6TOOdq1xUp0S4YoAKTCYMiiv6bBhbbNopDckhc2JIoCdvcplGCSv8YjpERlmU+p+b8CeoSXevlwIIWxQ6uXD7UUZjulRT+wthxnmsWJ4XM7DDZy2+03j7DEewRpN3smCHKn2q/HqBJajEylO88gZVRXGgfNygA4arto1vqNg2apvh1MD80dPzc6Qc7tMFmr7V7KnDGJkWJTy115I7utUvqUnae0+4iDsgzth+7/2q4fBEoo+iSgCt1/n3CPLz2DPAbV6Xt2mehCtfhBsUvdKkBIOUJk66P3h97uVeJi7TOhJhXr1lgrh52+t93L81NW5QvDYtuXp2mpuVMp9RmzCPWkMrD2cbOGsVIOX87MfhB83BEcIhH2M2ohErG1WvsHfefq23eqfHPJ4RYAAA==" />