--- title: Fetch Assets slug: fetch-assets docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "dECpF8SqxQSZGMB75Zgch", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/assets", "servers": [ { "url": "https://api.nue.io/assets", "description": "**Production Environment** - Live production server for all customer-facing operations. Use this for production integrations with real customer data and transactions." }, { "url": "https://api.sandbox.nue.io/assets", "description": "**Sandbox Environment** - Safe testing environment with sample data for development and integration testing. No rate limits apply. Data is reset weekly. Perfect for prototyping and QA testing." } ], "name": "Fetch Assets", "description": "

Retrieve asset information for customers or by specific asset number. Assets represent physical or digital products that have been delivered to customers. You can filter by status, include product details, and retrieve historical versions.

", "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": [ { "kind": "optional", "name": "customerIds", "type": "string", "example": "[\"cust-12345\", \"cust-67890\"]", "description": "

A JSON-encoded array of customer IDs to fetch assets for. Cannot be used with assetNumber.

" }, { "kind": "optional", "name": "assetNumber", "type": "string", "example": "AST-001234", "description": "Specific asset number to retrieve. Cannot be used with customerIds." }, { "kind": "optional", "name": "history", "type": "boolean", "description": "Whether to include historical versions of the asset. Only works with assetNumber." }, { "kind": "optional", "name": "includes", "type": "string", "description": "

Comma-separated list of additional data to include. Options: product, pricetags

", "enum": [ "product", "pricetags", "product,pricetags" ] }, { "kind": "optional", "name": "status", "type": "string", "description": "Filter assets by status", "enum": [ "shipped", "installed", "registered", "obsolete", "purchased" ] } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully retrieved assets", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved assets\n{\n \"status\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"assetNumber\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\",\n \"orderProductId\": \"\",\n \"quantity\": 0,\n \"installDate\": \"\",\n \"purchaseDate\": \"\",\n \"price\": 0,\n \"assetVersion\": 0,\n \"billingAccountId\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"product\": {\n \"id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"description\": \"\"\n },\n \"priceTags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n ]\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "label": "singleAssetByNumber", "code": "// Retrieve a specific asset by asset number\n{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"id\": \"ast-12345\",\n \"assetNumber\": \"AST-001234\",\n \"name\": \"Enterprise Software License\",\n \"status\": \"Installed\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-abcdef\",\n \"orderProductId\": \"op-123456\",\n \"quantity\": 5,\n \"installDate\": \"2024-01-15\",\n \"purchaseDate\": \"2024-01-10\",\n \"price\": 2500,\n \"assetVersion\": 1,\n \"billingAccountId\": \"ba-999888\",\n \"createdDate\": \"2024-01-10T10:00:00Z\",\n \"lastModifiedDate\": \"2024-01-15T14:30:00Z\"\n }\n ],\n \"warnings\": []\n}" }, { "label": "assetsByCustomerIds", "code": "// Retrieve assets for multiple customers\n{\n \"status\": \"PARTIAL_SUCCESS\",\n \"data\": [\n {\n \"id\": \"ast-12345\",\n \"assetNumber\": \"AST-001234\",\n \"name\": \"Enterprise Software License\",\n \"status\": \"Installed\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-abcdef\",\n \"quantity\": 3,\n \"price\": 1500\n },\n {\n \"id\": \"ast-67890\",\n \"assetNumber\": \"AST-001235\",\n \"name\": \"Professional Services\",\n \"status\": \"Shipped\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-ghijkl\",\n \"quantity\": 1,\n \"price\": 5000\n }\n ],\n \"warnings\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"No assets found for customer ID cust-11111.\"\n }\n ]\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "Status of the request", "enum": [ "SUCCESS", "PARTIAL_SUCCESS", "FAILURE" ] }, { "name": "data", "kind": "optional", "type": "array", "description": "Array of assets", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the asset" }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "Asset number identifier" }, { "name": "name", "kind": "optional", "type": "string", "description": "Asset name" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the asset" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer who owns this asset" }, { "name": "productId", "kind": "optional", "type": "string", "description": "ID of the product this asset represents" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "ID of the order product that created this asset" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity of the asset" }, { "name": "installDate", "kind": "optional", "type": "string", "description": "Date when the asset was installed", "format": "date" }, { "name": "purchaseDate", "kind": "optional", "type": "string", "description": "Date when the asset was purchased", "format": "date" }, { "name": "price", "kind": "optional", "type": "number", "description": "Price of the asset" }, { "name": "assetVersion", "kind": "optional", "type": "number", "description": "

Version number of the asset (for history tracking)

" }, { "name": "billingAccountId", "kind": "optional", "type": "string", "description": "ID of the billing account associated with this asset" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "When the asset was created", "format": "date-time" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "When the asset was last modified", "format": "date-time" }, { "name": "product", "kind": "optional", "type": "object", "description": "

Product details (included when includes=product)

", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "sku", "kind": "optional", "type": "string", "description": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "priceTags", "kind": "optional", "type": "array", "description": "

Price tags applied to this asset (included when includes=pricetags)

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "code", "kind": "optional", "type": "string", "description": "" } ] } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "Any warnings generated during processing", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "207", "description": "

Partial Success - Some customer IDs found, others not found

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "status", "kind": "required", "type": "string", "description": "Status of the request", "enum": [ "FAILURE" ] }, { "name": "errorType", "kind": "optional", "type": "string", "description": "Type of error that occurred", "enum": [ "NOT_FOUND", "INVALID_PARAMETER", "MISSING_PARAMETER", "INVALID_ARGUMENT", "AUTHENTICATION_ERROR" ] }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Specific error code for the failure", "enum": [ "MISSING_DETAILS_FETCH_PARAMETER", "MISSING_FETCH_PARAMETER", "INVALID_CUSTOMER_IDS_FORMAT", "INVALID_PARAMETER_COMBINATION", "ORDER_UNKNOWN_FIELD", "CUSTOMER_NOT_FOUND", "MISSING_AUTH_METHOD", "INSUFFICIENT_PERMISSIONS", "INVALID_JSON" ] }, { "name": "message", "kind": "required", "type": "string", "description": "

Human-readable error message

" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request - The request was malformed or contained invalid parameters

", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "missingParameters", "code": "// Missing required parameters\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"MISSING_PARAMETER\",\n \"errorCode\": \"MISSING_FETCH_PARAMETER\",\n \"message\": \"Either customerIds or asset number must be provided.\"\n}" }, { "label": "invalidCustomerIds", "code": "// Invalid customer IDs format\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n \"message\": \"Parameter customerIds must be a valid JSON array of non-empty strings.\"\n}" }, { "label": "invalidParameterCombination", "code": "// Invalid parameter combination\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_PARAMETER_COMBINATION\",\n \"message\": \"The customerIds and assetNumber parameters cannot be used together.\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "status", "kind": "required", "type": "string", "description": "Status of the request", "enum": [ "FAILURE" ] }, { "name": "errorType", "kind": "optional", "type": "string", "description": "Type of error that occurred", "enum": [ "NOT_FOUND", "INVALID_PARAMETER", "MISSING_PARAMETER", "INVALID_ARGUMENT", "AUTHENTICATION_ERROR" ] }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "Specific error code for the failure", "enum": [ "MISSING_DETAILS_FETCH_PARAMETER", "MISSING_FETCH_PARAMETER", "INVALID_CUSTOMER_IDS_FORMAT", "INVALID_PARAMETER_COMBINATION", "ORDER_UNKNOWN_FIELD", "CUSTOMER_NOT_FOUND", "MISSING_AUTH_METHOD", "INSUFFICIENT_PERMISSIONS", "INVALID_JSON" ] }, { "name": "message", "kind": "required", "type": "string", "description": "

Human-readable error message

" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized - Authentication failed

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Authentication failed — returned with HTTP 401. Two variants occur: a missing key is rejected by the gateway with {status: \"FAILURE\", errorCode, errorType, message}; an invalid key is rejected by the service with {status: 401, error, message}.

", "customType": "UnauthorizedError", "schema": [ { "name": "status", "kind": "optional", "type": "", "description": "

HTTP status code (e.g. 401) or the string \"FAILURE\" for gateway-level rejections.

" }, { "name": "error", "kind": "optional", "type": "string", "description": "

Error reason phrase (invalid-key variant).

" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Machine-readable error code, e.g. MISSING_AUTH_METHOD (missing-key variant).

" }, { "name": "errorType", "kind": "optional", "type": "string", "description": "

Error category, e.g. AUTHENTICATION_ERROR (missing-key variant).

" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable error message.

" } ], "modelRef": "#/components/schemas/UnauthorizedError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "JTgTUDgfSR60UiKj6lv-N", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/assets \\\n --header 'accept: application/json'" }, { "id": "V9M6GIZJFtWlCKwgwynWR", "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/assets\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "smuFidypZdD9eRXiBTHm1", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/assets\")\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": "_iSgYT_BSff87ao5v8Ay7", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/assets\"\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": "JTgTUDgfSR60UiKj6lv-N" }, "results": { "languages": [ { "id": "hiOf33Mo9v80-o14Ixu2q", "language": "200", "code": "// Successfully retrieved assets\n{\n \"status\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"assetNumber\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\",\n \"orderProductId\": \"\",\n \"quantity\": 0,\n \"installDate\": \"\",\n \"purchaseDate\": \"\",\n \"price\": 0,\n \"assetVersion\": 0,\n \"billingAccountId\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"product\": {\n \"id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"description\": \"\"\n },\n \"priceTags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n ]\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}", "subExamples": [ { "label": "GENERATED", "code": "// Successfully retrieved assets\n{\n \"status\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"assetNumber\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"customerId\": \"\",\n \"productId\": \"\",\n \"orderProductId\": \"\",\n \"quantity\": 0,\n \"installDate\": \"\",\n \"purchaseDate\": \"\",\n \"price\": 0,\n \"assetVersion\": 0,\n \"billingAccountId\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\",\n \"product\": {\n \"id\": \"\",\n \"name\": \"\",\n \"sku\": \"\",\n \"description\": \"\"\n },\n \"priceTags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"code\": \"\"\n }\n ]\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "label": "singleAssetByNumber", "code": "// Retrieve a specific asset by asset number\n{\n \"status\": \"SUCCESS\",\n \"data\": [\n {\n \"id\": \"ast-12345\",\n \"assetNumber\": \"AST-001234\",\n \"name\": \"Enterprise Software License\",\n \"status\": \"Installed\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-abcdef\",\n \"orderProductId\": \"op-123456\",\n \"quantity\": 5,\n \"installDate\": \"2024-01-15\",\n \"purchaseDate\": \"2024-01-10\",\n \"price\": 2500,\n \"assetVersion\": 1,\n \"billingAccountId\": \"ba-999888\",\n \"createdDate\": \"2024-01-10T10:00:00Z\",\n \"lastModifiedDate\": \"2024-01-15T14:30:00Z\"\n }\n ],\n \"warnings\": []\n}" }, { "label": "assetsByCustomerIds", "code": "// Retrieve assets for multiple customers\n{\n \"status\": \"PARTIAL_SUCCESS\",\n \"data\": [\n {\n \"id\": \"ast-12345\",\n \"assetNumber\": \"AST-001234\",\n \"name\": \"Enterprise Software License\",\n \"status\": \"Installed\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-abcdef\",\n \"quantity\": 3,\n \"price\": 1500\n },\n {\n \"id\": \"ast-67890\",\n \"assetNumber\": \"AST-001235\",\n \"name\": \"Professional Services\",\n \"status\": \"Shipped\",\n \"customerId\": \"cust-67890\",\n \"productId\": \"prod-ghijkl\",\n \"quantity\": 1,\n \"price\": 5000\n }\n ],\n \"warnings\": [\n {\n \"code\": \"NOT_FOUND\",\n \"message\": \"No assets found for customer ID cust-11111.\"\n }\n ]\n}" } ] }, { "id": "01MbDqggQIZu8AcTsqgeG", "language": "207", "code": "// Partial Success - Some customer IDs found, others not found\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "id": "qKLDr6zxFL6iyNaN59x_c", "language": "400", "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Bad Request - The request was malformed or contained invalid parameters\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "missingParameters", "code": "// Missing required parameters\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"MISSING_PARAMETER\",\n \"errorCode\": \"MISSING_FETCH_PARAMETER\",\n \"message\": \"Either customerIds or asset number must be provided.\"\n}" }, { "label": "invalidCustomerIds", "code": "// Invalid customer IDs format\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n \"message\": \"Parameter customerIds must be a valid JSON array of non-empty strings.\"\n}" }, { "label": "invalidParameterCombination", "code": "// Invalid parameter combination\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_PARAMETER_COMBINATION\",\n \"message\": \"The customerIds and assetNumber parameters cannot be used together.\"\n}" } ] }, { "id": "v_e94QgcyyGAubkjUt_nj", "language": "401", "code": "// Unauthorized - Authentication failed\n{\n \"status\": \"\",\n \"error\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n}" } ], "selectedLanguageId": "hiOf33Mo9v80-o14Ixu2q" } }, "children": [ { "text": "" } ] }