Custom Objects
The
Custom Object record refers to an instance of a Custom Object Class.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.
object_classUUIDThe custom object class the custom object record belongs to.
fieldsObjectThe fields and values contained within the custom object record.
remote_fieldsRemoteField[]GET
/custom-object-classes/{custom_object_class_id}/custom-objects
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects
US
EU
APAC
Returns a list of CustomObject 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
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_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).
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. The maximum limit is 100.
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
remote_idString
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_idString
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
remote_idStringNot seeing an integration that you're looking for?
POST
/custom-object-classes/{custom_object_class_id}/custom-objects
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects
US
EU
APAC
Creates a CustomObject 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.fieldsObjectintegration_paramsObjectlinked_account_paramsObjectField 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 for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
request_path_paramsObjectRequired
custom_object_class_idStringRequired
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
integration_paramsObjectRequired
custom_object_class_idStringRequired
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
request_path_paramsObjectRequired
custom_object_class_idStringRequired
Not seeing an integration that you're looking for?
To include the correct model fields when making POST requests, use the GET /custom-object-classes/{custom_object_class_id}/custom-objects/meta/post endpoint. Learn more in our /meta guide.
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{id}
US
EU
APAC
Returns a CustomObject object with the given id.
Query & path parameters
custom_object_class_idUUIDRequired
idUUIDRequired
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).
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
remote_idStringSalesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_idStringZendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
remote_idStringNot seeing an integration that you're looking for?
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post
US
EU
APAC
Returns metadata for CRMCustomObject POSTs.
Query & path parameters
custom_object_class_idUUIDRequired
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 for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
request_path_paramsObjectRequired
custom_object_class_idStringRequired
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
integration_paramsObjectRequired
custom_object_class_idStringRequired
Zendesk Sell
On top of normalized Common Models, Merge also supports Passthrough Requests for this platform's API
Supported POST Model Parameters
remote_idStringOptional
Additional POST Parameters
fieldsStringRequired
request_path_paramsObjectRequired
custom_object_class_idStringRequired
Not seeing an integration that you're looking for?
GET
/custom-object-classes/custom-objects/remote-field-classes
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/custom-objects/remote-field-classes
US
EU
APAC
Returns a list of RemoteFieldClass objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
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_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).
is_common_model_fieldBooleanOptional
If provided, will only return remote field classes with this is_common_model_field value
is_customBooleanOptional
If provided, will only return remote fields classes with this is_custom value
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.