Custom Objects
The Custom Object record refers to an instance of a Custom Object Class.
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.

object_classUUID
Optional
The custom object class the custom object record belongs to.

fieldsObject
Required
The fields and values contained within the custom object record.

remote_fieldsRemoteField[]
Required


GET
/custom-object-classes/{custom_object_class_id}/custom-objects
Beta

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects

US
EU

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.

cursorString
Optional
The pagination cursor value.

custom_object_class_idUUID
Required

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
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
POST
/custom-object-classes/{custom_object_class_id}/custom-objects
Beta

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects

US
EU

Creates a CustomObject object with the given values.


Query & Path Parameters

custom_object_class_idUUID
Required

is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters

modelObject
Required
Find available fields below under “Model Parameters”.
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.

fieldsObject
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
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}
Beta

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/{id}

US
EU

Returns a CustomObject object with the given id.


Query & Path Parameters

custom_object_class_idUUID
Required

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
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.
GET
/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post

https://api.merge.dev/api/crm/v1/custom-object-classes/{custom_object_class_id}/custom-objects/meta/post

US
EU

Returns metadata for CRMCustomObject POSTs.


Query & Path Parameters

custom_object_class_idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Salesforce
Salesforce
Not seeing an integration that you're looking for? Submit a request for it.