Engagement Types
The Engagement Type object is used to represent an interaction activity. A given Engagement typically has an Engagement Type object represented in the engagement_type field.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

activity_typeEnum
Optional
The engagement type's activity type. Possible values include: CALL, MEETING, EMAIL. In cases where there is no clear mapping, the original value passed through will be returned.

nameString
Optional
The engagement type's name.

remote_fieldsRemoteField[]
Required


GET
/engagement-types

https://api.merge.dev/api/crm/v1/engagement-types

US
EU
APAC

Returns a list of EngagementType objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

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

modified_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
ActiveCampaign
ActiveCampaign
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/engagement-types/{id}

https://api.merge.dev/api/crm/v1/engagement-types/{id}

US
EU
APAC

Returns an EngagementType object with the given id.


Query & Path Parameters

idUUID
Required

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

include_remote_fieldsBoolean
Optional
Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Accelo
Accelo
ActiveCampaign
ActiveCampaign
Capsule
Capsule
Close
Close
Copper
Copper
HubSpot
HubSpot
Insightly
Insightly
Keap
Keap
Microsoft Dynamics 365 Sales
Microsoft Dynamics 365 Sales
Nutshell
Nutshell
Pipedrive
Pipedrive
Salesflare
Salesflare
Salesforce
Salesforce
SugarCRM
SugarCRM
Teamleader
Teamleader
Teamwork CRM
Teamwork CRM
Vtiger
Vtiger
Zendesk Sell
Zendesk Sell
Zoho CRM
Zoho CRM
GET
/engagement-types/remote-field-classes
Closed Beta

https://api.merge.dev/api/crm/v1/engagement-types/remote-field-classes

US
EU
APAC

Returns a list of RemoteFieldClass objects.


Query & Path Parameters

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

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

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

is_common_model_fieldBoolean
Optional
If provided, will only return remote field classes with this is_common_model_field value

page_sizeInteger
Optional
Number of results to return per page.