Association Types
The
Association Type object represents the relationship between two objects.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
source_object_classObjectThe class of the source object (Custom Object or Common Model) for the association type.
target_object_classesAssociationSubType[]remote_key_nameStringdisplay_nameStringcardinalityEnum Possible values include:
ONE_TO_ONE, MANY_TO_ONE, MANY_TO_MANY, ONE_TO_MANY. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.is_requiredBooleanGET
/custom-object-classes/{custom_object_class_id}/association-types
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types
US
EU
APAC
Returns a list of AssociationType 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.
cursorStringOptional
The pagination cursor value.
custom_object_class_idUUIDRequired
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinalityEnumdisplay_nameStringremote_idStringremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestring
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_nameStringis_requiredBooleanremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestring
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinalityEnumdisplay_nameStringremote_idStringremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestringPOST
/custom-object-classes/{custom_object_class_id}/association-types
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types
US
EU
APAC
Creates an AssociationType object with the given values.
Query & path parameters
custom_object_class_idUUIDRequired
is_debug_modeBooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_asyncBooleanOptional
Whether or not third-party updates should be run asynchronously.
Body parameters
modelObjectRequired
Find available fields below under “Model Parameters”.
Model parameters
View app-specific writable fields under “Field support by platform” in this section.source_object_classObjecttarget_object_classesArrayremote_key_nameStringdisplay_nameStringcardinalityStringONE_TO_ONE- ONE_TO_ONE
is_requiredBooleanTo include the correct model fields when making POST requests, use the GET /custom-object-classes/{custom_object_class_id}/association-types/meta/post endpoint. Learn more in our /meta guide.
GET
/custom-object-classes/{custom_object_class_id}/association-types/{id}
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/{id}
US
EU
APAC
Returns an AssociationType object with the given id.
Query & path parameters
custom_object_class_idUUIDRequired
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinalityEnumdisplay_nameStringremote_idStringremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestringSalesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
display_nameStringis_requiredBooleanremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestringZendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinalityEnumdisplay_nameStringremote_idStringremote_key_nameStringtarget_object_classesAssociationSubType[]idstringcreated_atstringmodified_atstringorigin_typestringGET
/custom-object-classes/{custom_object_class_id}/association-types/meta/post
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/association-types/meta/post
US
EU
APAC
Returns metadata for CRMAssociationType POSTs.
Query & path parameters
custom_object_class_idUUIDRequired