---
title: List All Metadata Mappings
slug: list-all-metadata-mappings
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "TEjUeVQ75AFlqcV8hDzaf",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/v1/stripe/metadata-mapping",
    "servers": [
      {
        "url": "https://api.nue.io/v1/stripe/metadata-mapping",
        "description": "Nue API Production URL"
      },
      {
        "url": "https://api.sandbox.nue.io/v1/stripe/metadata-mapping",
        "description": "Nue Sandbox API Server"
      }
    ],
    "name": "List All Metadata Mappings",
    "description": "Retrieve all metadata mappings configured for your organization. These mappings define how data flows from Nue objects and fields to corresponding Stripe entities.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "apiKeyAuth",
          "name": "nue-api-key",
          "kind": "optional",
          "type": "apiKey",
          "in": "header"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Successfully retrieved metadata mappings",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// Successfully retrieved metadata mappings\n[\n  {\n    \"id\": \"\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingPostalCode\",\n    \"sourceValue\": \"\",\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.postal_code\"\n  }\n]"
          },
          {
            "label": "Customer Address Mappings",
            "code": "[\n  {\n    \"id\": \"0267d6bd-e7b5-4e3f-9dbe-0441d6489155\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingPostalCode\",\n    \"sourceValue\": null,\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.postal_code\"\n  },\n  {\n    \"id\": \"1234d6bd-e7b5-4e3f-9dbe-0441d6489156\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingCity\",\n    \"sourceValue\": null,\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.city\"\n  }\n]"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "array",
            "description": "",
            "customType": "MetadataMapping[]",
            "schema": [
              {
                "name": "id",
                "kind": "optional",
                "type": "string<uuid>",
                "description": "Unique identifier for the metadata mapping",
                "format": "uuid"
              },
              {
                "name": "sourceObject",
                "kind": "optional",
                "type": "string",
                "description": "<p>The Nue object to get data from (e.g., Customer, Order)</p>",
                "example": "Customer"
              },
              {
                "name": "sourceField",
                "kind": "optional",
                "type": "string",
                "description": "The field in the source object to get data from",
                "example": "billingPostalCode"
              },
              {
                "name": "sourceValue",
                "kind": "optional",
                "type": "string",
                "description": "A static value to use instead of a field value",
                "example": ""
              },
              {
                "name": "targetObject",
                "kind": "required",
                "type": "string",
                "description": "<p>The Stripe object to send data to (e.g., Customer, Invoice)</p>",
                "example": "Customer"
              },
              {
                "name": "targetField",
                "kind": "required",
                "type": "string",
                "description": "The field in the target object to send data to",
                "example": "address.postal_code"
              }
            ],
            "modelRef": "#/components/schemas/MetadataMapping",
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized - Invalid or missing API key</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "customType": "ErrorResponse",
            "schema": [
              {
                "name": "error",
                "kind": "optional",
                "type": "object",
                "description": "",
                "example": "",
                "schema": [
                  {
                    "name": "code",
                    "kind": "optional",
                    "type": "string",
                    "description": "Error code",
                    "example": "VALIDATION_ERROR"
                  },
                  {
                    "name": "message",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Human-readable error message</p>",
                    "example": "Invalid mapping configuration"
                  },
                  {
                    "name": "details",
                    "kind": "optional",
                    "type": "array",
                    "description": "Additional error details",
                    "example": "[\"Target field 'oid' is read-only\"]",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "modelRef": "#/components/schemas/ErrorResponse",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "FdGiv7NlUM0yLBS67bVje",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/v1/stripe/metadata-mapping \\\n     --header 'accept: application/json'"
        },
        {
          "id": "yleA0H-T3GHulr9GYMjES",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/v1/stripe/metadata-mapping\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "1qhzRoypEkHToaJSCkmG7",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/v1/stripe/metadata-mapping\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "_KZhXtkh7gbwYlmhnWC-l",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/v1/stripe/metadata-mapping\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "FdGiv7NlUM0yLBS67bVje"
    },
    "results": {
      "languages": [
        {
          "id": "BY9cTBkaX_SSe9a6tmLu9",
          "language": "200",
          "code": "// Successfully retrieved metadata mappings\n[\n  {\n    \"id\": \"\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingPostalCode\",\n    \"sourceValue\": \"\",\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.postal_code\"\n  }\n]",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// Successfully retrieved metadata mappings\n[\n  {\n    \"id\": \"\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingPostalCode\",\n    \"sourceValue\": \"\",\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.postal_code\"\n  }\n]"
            },
            {
              "label": "Customer Address Mappings",
              "code": "[\n  {\n    \"id\": \"0267d6bd-e7b5-4e3f-9dbe-0441d6489155\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingPostalCode\",\n    \"sourceValue\": null,\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.postal_code\"\n  },\n  {\n    \"id\": \"1234d6bd-e7b5-4e3f-9dbe-0441d6489156\",\n    \"sourceObject\": \"Customer\",\n    \"sourceField\": \"billingCity\",\n    \"sourceValue\": null,\n    \"targetObject\": \"Customer\",\n    \"targetField\": \"address.city\"\n  }\n]"
            }
          ]
        },
        {
          "id": "2543xDsBlw3Ejrw4yCLaU",
          "language": "401",
          "code": "// Unauthorized - Invalid or missing API key\n{\n  \"error\": {\n    \"code\": \"VALIDATION_ERROR\",\n    \"message\": \"Invalid mapping configuration\",\n    \"details\": [\n      \"\"\n    ]\n  }\n}"
        }
      ],
      "selectedLanguageId": "BY9cTBkaX_SSe9a6tmLu9"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}