Custom Object Classes
The
Custom Object Class
object is used to represent a Custom Object Schema in the remote system.Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
name
StringOptional
description
StringOptional
labels
ObjectRequired
fields
RemoteFieldClassForCustomObjectClass[]Required
association_types
ArrayOptional
GET
/custom-object-classes
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes
US
EU
Returns a list of CustomObjectClass
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.
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
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_id
StringNot seeing an integration that you're looking for? Submit a request for it.
GET
/custom-object-classes/{id}
Betahttps://api.merge.dev/api/crm/v1/custom-object-classes/{id}
US
EU
Returns a CustomObjectClass
object with the given id
.
Query & Path Parameters
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
Salesforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
name
Stringremote_id
StringNot seeing an integration that you're looking for? Submit a request for it.