Custom Object Classes
The Custom Object Class object is used to represent a Custom Object Schema in the remote system.
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
modified_atDateTime (ISO 8601)
nameString
The custom object class's name.
descriptionString
The custom object class's description.
labelsObject
The custom object class's singular and plural labels.
fieldsRemoteFieldClassForCustomObjectClass[]
association_typesArray
The types of associations with other models that the custom object class can have.
GET
/custom-object-classes
Beta

https://api.merge.dev/api/crm/v1/custom-object-classes

US
EU
APAC

Returns a list of CustomObjectClass 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.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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_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
Use the /linked-accounts endpoint to pull platform support information
HubSpot
HubSpot
Salesforce
Salesforce
Not seeing an integration that you're looking for?
GET
/custom-object-classes/{id}
Beta

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

US
EU
APAC

Returns a CustomObjectClass object with the given id.


Query & path parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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
HubSpot
Salesforce
Salesforce
Not seeing an integration that you're looking for?
Previous
Users
Next Up
Custom Objects