Custom Object Classes
The Custom Object Class object is used to represent a Custom Object Schema in the remote system.Properties
nameStringOptional
descriptionStringOptional
labelsObjectRequired
fieldsRemoteFieldClassForCustomObjectClass[]Required
association_typesArrayOptional
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atStringRequired
modified_atStringRequired
The CustomObjectClass object
JSON
{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
GET
/custom-object-classes
https://api.merge.dev/api/crm/v1/custom-object-classes
US
EU
Returns a list of CustomObjectClass objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}]}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!
GET
/custom-object-classes/{id}
https://api.merge.dev/api/crm/v1/custom-object-classes/{id}
US
EU
Returns a CustomObjectClass object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"name": "order","description": "Order object","labels": {"singular": "Order","plural": "Orders"},"fields": [{"display_name": "Order ID","remote_key_name": "order_id","description": "The unique ID for the order.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Order Quantity","remote_key_name": "order_quantity","description": "The number of items ordered.","is_required": true,"is_nested_list": false,"field_type": "number","field_format": null,"field_choices": [],"item_schema": null},{"display_name": "Customer Type","remote_key_name": "customer_type","description": "The type of customer.","is_required": true,"is_nested_list": false,"field_type": "string","field_format": null,"field_choices": ["New","Returning"],"item_schema": null}],"association_types": [{}],"id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602","remote_id": "9579977","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z"}
This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!