Association Types
The
Association Type
object represents the relationship between two objects.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
source_object_class
ObjectRequired
The class of the source object (Custom Object or Common Model) for the association type.
target_object_classes
AssociationSubType[]Required
remote_key_name
StringOptional
display_name
StringOptional
cardinality
EnumOptional
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.is_required
BooleanRequired
GET
/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_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
custom_object_class_id
UUIDRequired
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinality
Enumdisplay_name
Stringremote_id
Stringremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
string![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
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_name
Stringis_required
Booleanremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
string![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
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
cardinality
Enumdisplay_name
Stringremote_id
Stringremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
stringNot seeing an integration that you're looking for? Submit a request for it.
POST
/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_id
UUIDRequired
is_debug_mode
BooleanOptional
Whether to include debug fields (such as log file links) in the response.
run_async
BooleanOptional
Whether or not third-party updates should be run asynchronously.
Body Parameters
model
ObjectRequired
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.source_object_class
Objecttarget_object_classes
Arrayremote_key_name
Stringdisplay_name
Stringcardinality
StringONE_TO_ONE
- ONE_TO_ONE
is_required
BooleanTo 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_id
UUIDRequired
expand
StringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
![HubSpot](https://merge-api-production.s3.amazonaws.com/media/Hubspot_square.jpg)
HubSpot
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
cardinality
Enumdisplay_name
Stringremote_id
Stringremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
string![Salesforce](https://merge-api-production.s3.amazonaws.com/media/PlatformSalesforce.png)
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_name
Stringis_required
Booleanremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
string![Zendesk Sell](https://merge-api-production.s3.amazonaws.com/media/PlatformZendesk_8wt2TTW.png)
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
cardinality
Enumdisplay_name
Stringremote_id
Stringremote_key_name
Stringtarget_object_classes
AssociationSubType[]id
stringcreated_at
stringmodified_at
stringorigin_type
stringNot seeing an integration that you're looking for? Submit a request for it.
GET
/custom-object-classes/{custom_object_class_id}/association-types/meta/post
https://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_id
UUIDRequired