> This page is for Unified.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# /remote-fields

GET https://api.merge.dev/api/knowledgebase/v1/remote-fields

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).

Reference: https://docs.merge.dev/merge-unified/knowledge-base/linked-account/field-mapping/remote-fields-retrieve

## Authentication

- `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer"

## Servers

- `https://api.merge.dev/api` (Production, default)
- `https://api-eu.merge.dev/api` (ProductionEU)
- `https://api-ap.merge.dev/api` (ProductionAPSE1)
- `https://api-ap.merge.dev/api/knowledgebase/v1` (ProductionAPSE1)

## Request

### Query parameters

- `common_models` (string, optional) — A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.
- `include_example_values` (string, optional) — If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.

### Headers

- `X-Account-Token` (string, required) — Token identifying the end user.

## Response

### 200

- `Container` (list of RemoteFieldAPI, optional)
- `Article` (list of RemoteFieldAPI, optional)
- `Attachment` (list of RemoteFieldAPI, optional)
- `User` (list of RemoteFieldAPI, optional)
- `Group` (list of RemoteFieldAPI, optional)

## Types

### RemoteFieldAPI

- `schema` (map from string to any, required)
- `remote_key_name` (string, required)
- `remote_endpoint_info` (RemoteEndpointInfo, required)
- `advanced_metadata` (AdvancedMetadata, required, nullable)
- `example_values` (list of any, optional, nullable)
- `coverage` (RemoteFieldApiCoverage, optional, nullable)

### RemoteEndpointInfo

- `method` (string, required)
- `url_path` (string, required)
- `field_traversal_path` (list of any, required)

### AdvancedMetadata

- `id` (string, required)
- `display_name` (string, optional)
- `description` (string, optional)
- `is_required` (boolean, optional)
- `is_custom` (boolean, optional)
- `field_choices` (list of any, optional)

### RemoteFieldApiCoverage

## Examples

**Response**

```json
{
  "Container": [
    {
      "schema": {
        "type": "string"
      },
      "remote_key_name": "example_remote_key_name",
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_key_name"
        ]
      },
      "advanced_metadata": {
        "id": "string",
        "display_name": "string",
        "description": "string",
        "is_required": true,
        "is_custom": true,
        "field_choices": [
          null
        ]
      },
      "example_values": [
        "example"
      ],
      "coverage": 0.33
    }
  ],
  "Article": [
    {
      "schema": {
        "type": "string"
      },
      "remote_key_name": "example_remote_key_name",
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_key_name"
        ]
      },
      "advanced_metadata": {
        "id": "string",
        "display_name": "string",
        "description": "string",
        "is_required": true,
        "is_custom": true,
        "field_choices": [
          null
        ]
      },
      "example_values": [
        "example"
      ],
      "coverage": 0.33
    }
  ],
  "Attachment": [
    {
      "schema": {
        "type": "string"
      },
      "remote_key_name": "example_remote_key_name",
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_key_name"
        ]
      },
      "advanced_metadata": {
        "id": "string",
        "display_name": "string",
        "description": "string",
        "is_required": true,
        "is_custom": true,
        "field_choices": [
          null
        ]
      },
      "example_values": [
        "example"
      ],
      "coverage": 0.33
    }
  ],
  "User": [
    {
      "schema": {
        "type": "string"
      },
      "remote_key_name": "example_remote_key_name",
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_key_name"
        ]
      },
      "advanced_metadata": {
        "id": "string",
        "display_name": "string",
        "description": "string",
        "is_required": true,
        "is_custom": true,
        "field_choices": [
          null
        ]
      },
      "example_values": [
        "example"
      ],
      "coverage": 0.33
    }
  ],
  "Group": [
    {
      "schema": {
        "type": "string"
      },
      "remote_key_name": "example_remote_key_name",
      "remote_endpoint_info": {
        "method": "GET",
        "url_path": "/example-url-path",
        "field_traversal_path": [
          "example_key_name"
        ]
      },
      "advanced_metadata": {
        "id": "string",
        "display_name": "string",
        "description": "string",
        "is_required": true,
        "is_custom": true,
        "field_choices": [
          null
        ]
      },
      "example_values": [
        "example"
      ],
      "coverage": 0.33
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.merge.dev/api/knowledgebase/v1/remote-fields"

headers = {
    "X-Account-Token": "X-Account-Token",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.merge.dev/api/knowledgebase/v1/remote-fields';
const options = {
  method: 'GET',
  headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer <token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.merge.dev/api/knowledgebase/v1/remote-fields"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Account-Token", "X-Account-Token")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.merge.dev/api/knowledgebase/v1/remote-fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Account-Token"] = 'X-Account-Token'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.merge.dev/api/knowledgebase/v1/remote-fields")
  .header("X-Account-Token", "X-Account-Token")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.merge.dev/api/knowledgebase/v1/remote-fields', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Account-Token' => 'X-Account-Token',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.merge.dev/api/knowledgebase/v1/remote-fields");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Account-Token", "X-Account-Token");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Account-Token": "X-Account-Token",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/knowledgebase/v1/remote-fields")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```