/field-mappings

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.file_storage.field_mapping.field_mappings_retrieve()

{
  "File": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_integration_wide": true,
      "target_field": {
        "name": "example_target_field_name",
        "description": "this is a example description of a target field",
        "is_organization_wide": true
      },
      "remote_field": {
        "remote_key_name": "example_remote_field_key",
        "schema": {
          "type": "string"
        },
        "remote_endpoint_info": {
          "method": "GET",
          "url_path": "/example-url-path",
          "field_traversal_path": [
            "example_remote_field_key"
          ]
        }
      },
      "jmes_path": "[0].example_jmes_path",
      "advanced_mapping_expression": "$[0].example_jsonata"
    }
  ],
  "Folder": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_integration_wide": true,
      "target_field": {
        "name": "example_target_field_name",
        "description": "this is a example description of a target field",
        "is_organization_wide": true
      },
      "remote_field": {
        "remote_key_name": "example_remote_field_key",
        "schema": {
          "type": "string"
        },
        "remote_endpoint_info": {
          "method": "GET",
          "url_path": "/example-url-path",
          "field_traversal_path": [
            "example_remote_field_key"
          ]
        }
      },
      "jmes_path": "[0].example_jmes_path",
      "advanced_mapping_expression": "$[0].example_jsonata"
    }
  ],
  "Drive": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_integration_wide": true,
      "target_field": {
        "name": "example_target_field_name",
        "description": "this is a example description of a target field",
        "is_organization_wide": true
      },
      "remote_field": {
        "remote_key_name": "example_remote_field_key",
        "schema": {
          "type": "string"
        },
        "remote_endpoint_info": {
          "method": "GET",
          "url_path": "/example-url-path",
          "field_traversal_path": [
            "example_remote_field_key"
          ]
        }
      },
      "jmes_path": "[0].example_jmes_path",
      "advanced_mapping_expression": "$[0].example_jsonata"
    }
  ],
  "Group": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_integration_wide": true,
      "target_field": {
        "name": "example_target_field_name",
        "description": "this is a example description of a target field",
        "is_organization_wide": true
      },
      "remote_field": {
        "remote_key_name": "example_remote_field_key",
        "schema": {
          "type": "string"
        },
        "remote_endpoint_info": {
          "method": "GET",
          "url_path": "/example-url-path",
          "field_traversal_path": [
            "example_remote_field_key"
          ]
        }
      },
      "jmes_path": "[0].example_jmes_path",
      "advanced_mapping_expression": "$[0].example_jsonata"
    }
  ],
  "User": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "is_integration_wide": true,
      "target_field": {
        "name": "example_target_field_name",
        "description": "this is a example description of a target field",
        "is_organization_wide": true
      },
      "remote_field": {
        "remote_key_name": "example_remote_field_key",
        "schema": {
          "type": "string"
        },
        "remote_endpoint_info": {
          "method": "GET",
          "url_path": "/example-url-path",
          "field_traversal_path": [
            "example_remote_field_key"
          ]
        }
      },
      "jmes_path": "[0].example_jmes_path",
      "advanced_mapping_expression": "$[0].example_jsonata"
    }
  ]
}

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

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/).

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

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

Filelist of objects or null

Folderlist of objects or null

Drivelist of objects or null

Grouplist of objects or null

Userlist of objects or null

Authentication

Headers

Query parameters

Response