Merge Docs

Remote Data

Learn how to get the latest integration data in the original format Merge received it in.

Overview

Using Merge’s remote data, you can get the latest integration data in the original format Merge received it in.

If you set Merge's include_remote_data query parameter to true, Merge will include original data as we saw it from the remote API endpoint. This approach is ideal for when you’re looking for an extra field specific to an integration that is not included in Merge’s standardized format.

If you're looking for data from an endpoint that we do not include in our common data models, you may need to create an Authenticated Pass-through Request instead.


Query Parameters


include_remote_dataBoolean
Indicates whether the latest remote data should be included with the requested resource.

Fetching with the Merge SDK

See below for an example of how to get remote data via Merge’s SDK:

Remote Data via SDK
1employees_response = employees_api_instance.employees_list("YOUR_ACCOUNT_TOKEN", include_remote_data=True)

Response

Resources fetched with remote data will look like the following:

Remote Data Example
JSON
{
"id": "83622854-bb75-476f-9e67-a145593de468",
"remote_id": "8324",
...
...
"remote_data": [
{
"path": "/employees",
"data": {
"id": 8324,
"name": "Gil Feig"
}
},
{
"path": "/locations",
"data": {
"id": 998,
"employee_id": 8324,
"city": "San Francisco",
"state": "CA"
}
}
]
}