Retrieve all available fields for a specific Nue source object. These fields can be used as sources in metadata mappings to provide data to Stripe. For related objects, use the lookupRelation.relationName value as the field name.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "objectName", "type": "string", "example": "Customer", "description": "The name of the Nue source object", "enum": [ "Customer", "Order" ] } ], "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 source object fields", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved source object fields\n[\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"creatable\": false,\n \"updatable\": false,\n \"required\": false,\n \"lookupRelation\": {\n \"referenceTo\": \"\",\n \"referenceField\": \"\",\n \"relationName\": \"\",\n \"relationLabel\": \"\"\n }\n }\n]" }, { "label": "Customer Fields", "code": "[\n {\n \"apiName\": \"billingPostalCode\",\n \"name\": \"Billing Postal Code\",\n \"type\": \"text\",\n \"description\": \"Postal code for billing address\",\n \"creatable\": true,\n \"updatable\": true,\n \"required\": false\n },\n {\n \"apiName\": \"billingAccountId\",\n \"name\": \"Billing Account\",\n \"type\": \"lookup\",\n \"description\": \"Reference to billing account\",\n \"creatable\": true,\n \"updatable\": true,\n \"required\": false,\n \"lookupRelation\": {\n \"referenceTo\": \"Customer\",\n \"referenceField\": \"id\",\n \"relationName\": \"billingAccount\",\n \"relationLabel\": \"Billing Account\"\n }\n }\n]" } ], "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "FieldMetadata[]", "schema": [ { "name": "apiName", "kind": "optional", "type": "string", "description": "The API name of the field" }, { "name": "name", "kind": "optional", "type": "string", "description": "The display name of the field" }, { "name": "type", "kind": "optional", "type": "string", "description": "The data type of the field" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the field" }, { "name": "creatable", "kind": "optional", "type": "boolean", "description": "Whether the field can be created" }, { "name": "updatable", "kind": "optional", "type": "boolean", "description": "Whether the field can be updated" }, { "name": "required", "kind": "optional", "type": "boolean", "description": "Whether the field is required" }, { "name": "lookupRelation", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/LookupRelation", "customType": "LookupRelation", "schema": [ { "name": "referenceTo", "kind": "optional", "type": "string", "description": "The object this field references" }, { "name": "referenceField", "kind": "optional", "type": "string", "description": "The field in the referenced object" }, { "name": "relationName", "kind": "optional", "type": "string", "description": "The name of the relationship" }, { "name": "relationLabel", "kind": "optional", "type": "string", "description": "The display label for the relationship" } ] } ], "modelRef": "#/components/schemas/FieldMetadata", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request - Invalid object name
", "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": "Human-readable error message
", "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 } ] }, { "statusCode": "401", "description": "Unauthorized - Invalid or missing API key
", "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": "Human-readable error message
", "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": "AexbXyg7F9h61n5g3SWnn", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/v1/stripe/metadata-mapping/sourceObject/{objectName}/fields \\\n --header 'accept: application/json'" }, { "id": "QTRsfZ5M3M8rQMpcmebMe", "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/sourceObject/{objectName}/fields\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "bB-dqhztilK8emObdxOpN", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/v1/stripe/metadata-mapping/sourceObject/{objectName}/fields\")\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": "Ok8PEJNhYW2CPQK1GglB1", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/v1/stripe/metadata-mapping/sourceObject/{objectName}/fields\"\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": "AexbXyg7F9h61n5g3SWnn" }, "results": { "languages": [ { "id": "KGR-GcdSlYC5q6-BzIDju", "language": "200", "code": "// Successfully retrieved source object fields\n[\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"creatable\": false,\n \"updatable\": false,\n \"required\": false,\n \"lookupRelation\": {\n \"referenceTo\": \"\",\n \"referenceField\": \"\",\n \"relationName\": \"\",\n \"relationLabel\": \"\"\n }\n }\n]", "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved source object fields\n[\n {\n \"apiName\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"description\": \"\",\n \"creatable\": false,\n \"updatable\": false,\n \"required\": false,\n \"lookupRelation\": {\n \"referenceTo\": \"\",\n \"referenceField\": \"\",\n \"relationName\": \"\",\n \"relationLabel\": \"\"\n }\n }\n]" }, { "label": "Customer Fields", "code": "[\n {\n \"apiName\": \"billingPostalCode\",\n \"name\": \"Billing Postal Code\",\n \"type\": \"text\",\n \"description\": \"Postal code for billing address\",\n \"creatable\": true,\n \"updatable\": true,\n \"required\": false\n },\n {\n \"apiName\": \"billingAccountId\",\n \"name\": \"Billing Account\",\n \"type\": \"lookup\",\n \"description\": \"Reference to billing account\",\n \"creatable\": true,\n \"updatable\": true,\n \"required\": false,\n \"lookupRelation\": {\n \"referenceTo\": \"Customer\",\n \"referenceField\": \"id\",\n \"relationName\": \"billingAccount\",\n \"relationLabel\": \"Billing Account\"\n }\n }\n]" } ] }, { "id": "z-NFru2-zroTGLiOnjSpu", "language": "400", "code": "// Bad Request - Invalid object name\n{\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"Invalid mapping configuration\",\n \"details\": [\n \"\"\n ]\n }\n}" }, { "id": "WFm16skt57iK2lj1DgS-q", "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": "KGR-GcdSlYC5q6-BzIDju" } }, "children": [ { "text": "" } ] }