---
title: Export Nue on Salesforce system settings
slug: export-nue-on-salesforce-system-settings
docTags: 
createdAt: 2026-08-25T19:28:59.170Z
---

{
  "id": "gb3zhEL8ceNZGMETJN7sK",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.nue.io/cpq/settings/setting:export",
    "servers": [
      {
        "url": "https://api.nue.io/cpq/settings/setting:export",
        "description": "Nue Production API Endpoint"
      },
      {
        "url": "https://api.sandbox.nue.io/cpq/settings/setting:export",
        "description": "Nue Sandbox API Endpoint"
      }
    ],
    "name": "Export Nue on Salesforce system settings",
    "description": "<p>Export all Nue on Salesforce system configuration settings for backup, migration, or review purposes. This includes subscription settings, quote and order configurations, renewal settings, billing preferences, and custom pricing attributes.</p>",
    "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 exported Nue on Salesforce system settings",
        "jsonExample": "",
        "isExpanded": true,
        "subExamples": [
          {
            "label": "GENERATED",
            "code": "// Successfully exported Nue on Salesforce system settings\n{\n  \"allSettings\": [\n    {\n      \"id\": \"\",\n      \"category\": \"\",\n      \"subCategory\": \"\",\n      \"settings\": \"\"\n    }\n  ],\n  \"pricingAttributes\": [\n    {\n      \"name\": \"\",\n      \"apiName\": \"\",\n      \"description\": \"\",\n      \"mapping\": \"\",\n      \"options\": [\n        \"\"\n      ]\n    }\n  ]\n}"
          },
          {
            "label": "CPQ Settings Export",
            "code": "{\n  \"allSettings\": [\n    {\n      \"id\": \"a0rOy00001RfRqbIAF\",\n      \"category\": \"Lifecycle Manager\",\n      \"subCategory\": \"Subscriptions\",\n      \"settings\": {\n        \"coTermOption\": \"usersChoose\",\n        \"renewWithQuantityUpdate\": \"true\",\n        \"subscriptionTermDimension\": \"Month\",\n        \"defaultSubscriptionTerm\": \"12\"\n      }\n    }\n  ],\n  \"pricingAttributes\": [\n    {\n      \"name\": \"Account Type\",\n      \"apiName\": \"PricingAttribute_1\",\n      \"description\": \"Custom Pricing Attribute\",\n      \"mapping\": \"Quote.AccountId.Type\",\n      \"options\": [\n        \"Prospect\",\n        \"Customer - Direct\",\n        \"Customer - Channel\"\n      ]\n    }\n  ]\n}"
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "allSettings",
                "kind": "optional",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "description": "Unique identifier for this setting group"
                  },
                  {
                    "name": "category",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Main category of settings (e.g., Lifecycle Manager, Revenue Manager)</p>"
                  },
                  {
                    "name": "subCategory",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Sub-category for more specific grouping</p>"
                  },
                  {
                    "name": "settings",
                    "kind": "optional",
                    "type": "map",
                    "description": "<p>Key-value pairs of configuration settings</p>",
                    "example": "",
                    "customType": "map<string, string>",
                    "schema": []
                  }
                ]
              },
              {
                "name": "pricingAttributes",
                "kind": "optional",
                "type": "array",
                "description": "",
                "example": "",
                "itemType": "object",
                "customType": "object[]",
                "schema": [
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "Display name of the pricing attribute"
                  },
                  {
                    "name": "apiName",
                    "kind": "optional",
                    "type": "string",
                    "description": "API name for programmatic access"
                  },
                  {
                    "name": "description",
                    "kind": "optional",
                    "type": "string",
                    "description": "Description of the pricing attribute"
                  },
                  {
                    "name": "mapping",
                    "kind": "optional",
                    "type": "string",
                    "description": "Field mapping for dynamic value retrieval"
                  },
                  {
                    "name": "options",
                    "kind": "optional",
                    "type": "array",
                    "description": "Available options for this pricing attribute",
                    "example": "",
                    "itemType": "string",
                    "customType": "string[]",
                    "itemExample": "",
                    "itemDefault": ""
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "400",
        "description": "Bad Request",
        "jsonExample": "",
        "isExpanded": true
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "FlEa71tVK64YsMfRVg_77",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.nue.io/cpq/settings/setting:export \\\n     --header 'accept: application/json'"
        },
        {
          "id": "SbDHYUtXhGepqvSw1nOOR",
          "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/cpq/settings/setting:export\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "lj8are4fmH5uXBzZ31f9Q",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/settings/setting:export\")\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": "CG7aF0iEvUARJmZvRLS5Q",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/settings/setting:export\"\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": "FlEa71tVK64YsMfRVg_77"
    },
    "results": {
      "languages": [
        {
          "id": "EmPVqx2mu-QgFbjM5C75m",
          "language": "200",
          "code": "// Successfully exported Nue on Salesforce system settings\n{\n  \"allSettings\": [\n    {\n      \"id\": \"\",\n      \"category\": \"\",\n      \"subCategory\": \"\",\n      \"settings\": \"\"\n    }\n  ],\n  \"pricingAttributes\": [\n    {\n      \"name\": \"\",\n      \"apiName\": \"\",\n      \"description\": \"\",\n      \"mapping\": \"\",\n      \"options\": [\n        \"\"\n      ]\n    }\n  ]\n}",
          "subExamples": [
            {
              "label": "GENERATED",
              "code": "// Successfully exported Nue on Salesforce system settings\n{\n  \"allSettings\": [\n    {\n      \"id\": \"\",\n      \"category\": \"\",\n      \"subCategory\": \"\",\n      \"settings\": \"\"\n    }\n  ],\n  \"pricingAttributes\": [\n    {\n      \"name\": \"\",\n      \"apiName\": \"\",\n      \"description\": \"\",\n      \"mapping\": \"\",\n      \"options\": [\n        \"\"\n      ]\n    }\n  ]\n}"
            },
            {
              "label": "CPQ Settings Export",
              "code": "{\n  \"allSettings\": [\n    {\n      \"id\": \"a0rOy00001RfRqbIAF\",\n      \"category\": \"Lifecycle Manager\",\n      \"subCategory\": \"Subscriptions\",\n      \"settings\": {\n        \"coTermOption\": \"usersChoose\",\n        \"renewWithQuantityUpdate\": \"true\",\n        \"subscriptionTermDimension\": \"Month\",\n        \"defaultSubscriptionTerm\": \"12\"\n      }\n    }\n  ],\n  \"pricingAttributes\": [\n    {\n      \"name\": \"Account Type\",\n      \"apiName\": \"PricingAttribute_1\",\n      \"description\": \"Custom Pricing Attribute\",\n      \"mapping\": \"Quote.AccountId.Type\",\n      \"options\": [\n        \"Prospect\",\n        \"Customer - Direct\",\n        \"Customer - Channel\"\n      ]\n    }\n  ]\n}"
            }
          ]
        },
        {
          "id": "x9Xf32n6mEFg8MKJdpcxv",
          "language": "400",
          "code": "// Bad Request\n"
        }
      ],
      "selectedLanguageId": "EmPVqx2mu-QgFbjM5C75m"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}