For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
    • File Picker
        • Field Mapping
          • GET/field-mappings
          • POST/field-mappings
          • DEL/field-mappings/{field_mapping_id}
          • PATCH/field-mappings/{field_mapping_id}
          • GET/remote-fields
          • GET/target-fields
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Linked AccountField Mapping

/field-mappings

GET
/filestorage/v1/field-mappings
GET
/api/filestorage/v1/field-mappings
$curl https://api.merge.dev/api/filestorage/v1/field-mappings \
>     -H "X-Account-Token: X-Account-Token" \
>     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "File": [
3    {
4      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
5      "is_integration_wide": true,
6      "target_field": {
7        "name": "example_target_field_name",
8        "description": "this is a example description of a target field",
9        "is_organization_wide": true
10      },
11      "remote_field": {
12        "remote_key_name": "example_remote_field_key",
13        "schema": {
14          "type": "string"
15        },
16        "remote_endpoint_info": {
17          "method": "GET",
18          "url_path": "/example-url-path",
19          "field_traversal_path": [
20            "example_remote_field_key"
21          ]
22        }
23      },
24      "jmes_path": "[0].example_jmes_path",
25      "advanced_mapping_expression": "$[0].example_jsonata"
26    }
27  ],
28  "Folder": [
29    {
30      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
31      "is_integration_wide": true,
32      "target_field": {
33        "name": "example_target_field_name",
34        "description": "this is a example description of a target field",
35        "is_organization_wide": true
36      },
37      "remote_field": {
38        "remote_key_name": "example_remote_field_key",
39        "schema": {
40          "type": "string"
41        },
42        "remote_endpoint_info": {
43          "method": "GET",
44          "url_path": "/example-url-path",
45          "field_traversal_path": [
46            "example_remote_field_key"
47          ]
48        }
49      },
50      "jmes_path": "[0].example_jmes_path",
51      "advanced_mapping_expression": "$[0].example_jsonata"
52    }
53  ],
54  "Drive": [
55    {
56      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
57      "is_integration_wide": true,
58      "target_field": {
59        "name": "example_target_field_name",
60        "description": "this is a example description of a target field",
61        "is_organization_wide": true
62      },
63      "remote_field": {
64        "remote_key_name": "example_remote_field_key",
65        "schema": {
66          "type": "string"
67        },
68        "remote_endpoint_info": {
69          "method": "GET",
70          "url_path": "/example-url-path",
71          "field_traversal_path": [
72            "example_remote_field_key"
73          ]
74        }
75      },
76      "jmes_path": "[0].example_jmes_path",
77      "advanced_mapping_expression": "$[0].example_jsonata"
78    }
79  ],
80  "Group": [
81    {
82      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
83      "is_integration_wide": true,
84      "target_field": {
85        "name": "example_target_field_name",
86        "description": "this is a example description of a target field",
87        "is_organization_wide": true
88      },
89      "remote_field": {
90        "remote_key_name": "example_remote_field_key",
91        "schema": {
92          "type": "string"
93        },
94        "remote_endpoint_info": {
95          "method": "GET",
96          "url_path": "/example-url-path",
97          "field_traversal_path": [
98            "example_remote_field_key"
99          ]
100        }
101      },
102      "jmes_path": "[0].example_jmes_path",
103      "advanced_mapping_expression": "$[0].example_jsonata"
104    }
105  ],
106  "User": [
107    {
108      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
109      "is_integration_wide": true,
110      "target_field": {
111        "name": "example_target_field_name",
112        "description": "this is a example description of a target field",
113        "is_organization_wide": true
114      },
115      "remote_field": {
116        "remote_key_name": "example_remote_field_key",
117        "schema": {
118          "type": "string"
119        },
120        "remote_endpoint_info": {
121          "method": "GET",
122          "url_path": "/example-url-path",
123          "field_traversal_path": [
124            "example_remote_field_key"
125          ]
126        }
127      },
128      "jmes_path": "[0].example_jmes_path",
129      "advanced_mapping_expression": "$[0].example_jsonata"
130    }
131  ]
132}
Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/).
Was this page helpful?
Previous

Field Mapping

Next

/field-mappings

Built with

Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. Learn more.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

exclude_remote_field_metadatabooleanOptional

If true, remote fields metadata is excluded from each field mapping instance (i.e. remote_fields.remote_key_name and remote_fields.schema will be null). This will increase the speed of the request since these fields require some calculations.

Response

Containerlist of objects
Articlelist of objects
Attachmentlist of objects
Userlist of objects
Grouplist of objects