Pulling Remote Field ClassesBeta

Pull metadata and values for all fields from Remote Source Models in a standardized format, including standard and custom fields.
This feature is only available to customers on our Professional and Enterprise plans. View the Merge Plans to learn more.
Endpoints and Query Parameters
GET
/{common_model_name}/remote-field-classes
Read Remote Field Classes for a Common Model
GET
/{common_model_name}
?include_remote_fields=True
Read Remote Field Classes and values for a Common Model
GET
/{common_model_name}/{id}?include_remote_fields=True
Read Remote Field Classes and values for a Common Model instance
Example

For this example, let’s use custom fields set up on the Contacts model in Hubspot, which is mapped to the Merge Contact Common Model.

We can access Remote Field Classes for Contacts using this endpoint:

GET
https://api.merge.dev/api/crm/v1/contacts/remote-field-classes

These two Remote Field Classes in the response are both custom fields defined by a Hubspot user, as we can tell from the is_custom flag being set to true.

The test_dropdown_custom_field also has a list of accepted values under field_choices.

Meanwhile, these two Remote Field Classes are standard fields from Hubspot, as the is_custom flag is set to false.

To access Remote Field Classes and values for a specific Contact, use the include_remote_fields=True query parameter.

This returns all of an object’s properties including Remote Field Classes metadata and values.

Previous
Remote Field Classes
Next Up
Pushing Data