Retrieves customer information based on the provided customer IDs, allowing you to access details for multiple customers in a single request. IDs can be either the relevant Salesforce ID or the Nue UUID depending on the initial source of the customer.
", "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": "required", "name": "customerIds", "type": "string", "description": "A JSON-encoded array of customer IDs to fetch the corresponding customer information.
" }, { "kind": "optional", "name": "includes", "type": "string", "description": "A list of fields to include in the response. Current options are contacts.", "enum": [ "contacts" ] } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully retrieved customer information", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "stringUnique identifier for the account, formatted as C-{00000000}
" }, { "name": "accountSource", "kind": "optional", "type": "stringAnnual revenue of the customer, represented in currency
" }, { "name": "autoRenew", "kind": "optional", "type": "stringCustomer auto Renew, available options: Yes, No, DefaultToSubscriptionConfiguration
", "enum": [ "Yes", "No", "DefaultToSubscriptionConfiguration" ] }, { "name": "billCycleDay", "kind": "optional", "type": "string<1st of Month | 2nd of Month | 3rd of Month | 4th of Month | 5th of Month | 6th of Month | 7th of Month | 8th of Month | 9th of Month | 10th of Month | 11th of Month | 12th of Month | 13th of Month | 14th of Month | 15th of Month | 16th of Month | 17th of Month | 18th of Month | 19th of Month | 20th of Month | 21st of Month | 22nd of Month | 23rd of Month | 24th of Month | 25th of Month | 26th of Month | 27th of Month | 28th of Month | 29th of Month | 30th of Month | 31st of Month>", "description": "Billing Cycle Date", "enum": [ "1st of Month", "2nd of Month", "3rd of Month", "4th of Month", "5th of Month", "6th of Month", "7th of Month", "8th of Month", "9th of Month", "10th of Month", "11th of Month", "12th of Month", "13th of Month", "14th of Month", "15th of Month", "16th of Month", "17th of Month", "18th of Month", "19th of Month", "20th of Month", "21st of Month", "22nd of Month", "23rd of Month", "24th of Month", "25th of Month", "26th of Month", "27th of Month", "28th of Month", "29th of Month", "30th of Month", "31st of Month" ] }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>", "description": "Starting month for the billing cycle", "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12" ] }, { "name": "billingCity", "kind": "optional", "type": "string", "description": "City where the billing address is located" }, { "name": "billingCountry", "kind": "optional", "type": "string", "description": "Country where the billing address is located" }, { "name": "billingPostalCode", "kind": "optional", "type": "string", "description": "Postal code for the billing address" }, { "name": "billingState", "kind": "optional", "type": "string", "description": "State or province for the billing address" }, { "name": "billingStreet", "kind": "optional", "type": "string", "description": "Street address for billing purposes" }, { "name": "billingProrationEnabled", "kind": "optional", "type": "stringSize category of the company, e.g., small, medium, large
" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "Identifier of the user who created the customer record" }, { "name": "createdDate", "kind": "optional", "type": "stringUnique identifier for the customer record, either from Salesforce or Nue
" }, { "name": "imageSignedUrl", "kind": "optional", "type": "stringType of ownership of the customer, e.g., public, private, subsidiary
", "enum": [ "Public", "Private", "Subsidiary", "Other" ] }, { "name": "parentCustomerId", "kind": "optional", "type": "string", "description": "Identifier for the parent customer record, if applicable
" }, { "name": "paymentMethod", "kind": "optional", "type": "stringType of record for the customer, e.g., consumer, business
" }, { "name": "salesAccountId", "kind": "optional", "type": "string", "description": "Identifier for the sales account associated with the customer" }, { "name": "shippingCity", "kind": "optional", "type": "string", "description": "City where the shipping address is located" }, { "name": "shippingCountry", "kind": "optional", "type": "string", "description": "Country where the shipping address is located" }, { "name": "shippingPostalCode", "kind": "optional", "type": "string", "description": "Postal code for the shipping address" }, { "name": "shippingState", "kind": "optional", "type": "string", "description": "State or province for the shipping address" }, { "name": "shippingStreet", "kind": "optional", "type": "string", "description": "Street address for shipping purposes" }, { "name": "site", "kind": "optional", "type": "string", "description": "Information about the customer's site or location" }, { "name": "taxExempt", "kind": "optional", "type": "stringRolled-up Annual Recurring Revenue as of the current date
" }, { "name": "todayRollupCMRR", "kind": "optional", "type": "number", "description": "Rolled-up Committed Monthly Recurring Revenue as of the current date
" }, { "name": "totalTCV", "kind": "optional", "type": "number", "description": "Total Contract Value for the customer" }, { "name": "type", "kind": "optional", "type": "stringClassification of the customer account, e.g., prospect, direct, channel
", "enum": [ "Prospect", "Customer - Direct", "Customer - Channel", "Channel Partner / Reseller", "Installation Partner", "Technology Partner", "Other" ] }, { "name": "website", "kind": "optional", "type": "stringBad 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": "missingParameter", "code": "// Missing required parameter\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"MISSING_PARAMETER\",\n \"errorCode\": \"MISSING_DETAILS_FETCH_PARAMETER\",\n \"message\": \"Missing required fields: customerIds\"\n}" }, { "label": "invalidFormat", "code": "// Invalid parameter format\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n \"message\": \"Invalid format for customerIds parameter. Expected JSON array of strings.\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "status", "kind": "required", "type": "stringHuman-readable error message
" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized - Authentication information is missing or invalid
", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Unauthorized - Authentication information is missing or invalid\n{\n \"status\": \"\",\n \"error\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n}" }, { "label": "missingApiKey", "code": "// Missing API key\n{\n \"status\": \"FAILURE\",\n \"errorCode\": \"MISSING_AUTH_METHOD\",\n \"errorType\": \"AUTHENTICATION_ERROR\",\n \"message\": \"No authentication method provided in the request.\"\n}" }, { "label": "invalidApiKey", "code": "// Invalid API key\n{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Invalid api key invalid-key\"\n}" } ], "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 } ] }, { "statusCode": "404", "description": "Not Found - The requested resource was not found
", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Not Found - The requested resource was not found\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "customerNotFound", "code": "// Customer not found\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"NOT_FOUND\",\n \"errorCode\": \"CUSTOMER_NOT_FOUND\",\n \"message\": \"No customers found matching the provided customer IDs.\"\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "status", "kind": "required", "type": "stringHuman-readable error message
" } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "txPcJdOYTOnjEBl39N-z2", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.nue.io/customers?customerIds=string' \\\n --header 'accept: application/json'" }, { "id": "O4gZrcxMTQwyCbkmM-TYK", "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/customers?customerIds=string\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "RMBOSA223txEjYCT99Mtr", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/customers?customerIds=string\")\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": "vunHVj1nHcpb88xJF3spu", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/customers?customerIds=string\"\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": "txPcJdOYTOnjEBl39N-z2" }, "results": { "languages": [ { "id": "_0Y9vArL5gNMjV2MMlSVS", "language": "200", "code": "// Successfully retrieved customer information\n{\n \"status\": \"\",\n \"data\": [\n {\n \"accountNumber\": \"\",\n \"accountSource\": \"\",\n \"annualRevenue\": 0,\n \"autoRenew\": \"\",\n \"billCycleDay\": \"\",\n \"billCycleStartMonth\": \"\",\n \"billingCity\": \"\",\n \"billingCountry\": \"\",\n \"billingPostalCode\": \"\",\n \"billingState\": \"\",\n \"billingStreet\": \"\",\n \"billingProrationEnabled\": \"\",\n \"companySize\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerSince\": \"\",\n \"description\": \"\",\n \"eInvoicingEndpointId\": \"\",\n \"eInvoicingSchemaId\": \"\",\n \"email\": \"\",\n \"entityId\": \"\",\n \"entityUseCode\": \"\",\n \"fax\": \"\",\n \"funding\": \"\",\n \"id\": \"\",\n \"imageSignedUrl\": \"\",\n \"industry\": \"\",\n \"invoiceBalance\": 0,\n \"lastInvoiceDate\": \"\",\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"latestOrderDate\": \"\",\n \"legalEntityName\": \"\",\n \"name\": \"\",\n \"numberOfEmployees\": 0,\n \"orderPrimaryContactId\": \"\",\n \"ownership\": \"\",\n \"parentCustomerId\": \"\",\n \"paymentMethod\": \"\",\n \"paymentMethods\": [\n \"\"\n ],\n \"paymentTerm\": \"\",\n \"phone\": \"\",\n \"recordType\": \"\",\n \"salesAccountId\": \"\",\n \"shippingCity\": \"\",\n \"shippingCountry\": \"\",\n \"shippingPostalCode\": \"\",\n \"shippingState\": \"\",\n \"shippingStreet\": \"\",\n \"site\": \"\",\n \"taxExempt\": \"\",\n \"timezone\": \"\",\n \"todayARR\": 0,\n \"todayCMRR\": 0,\n \"todayRollupARR\": 0,\n \"todayRollupCMRR\": 0,\n \"totalTCV\": 0,\n \"type\": \"\",\n \"website\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "1BCOqq7e37C9PJaqWoDNR", "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": "missingParameter", "code": "// Missing required parameter\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"MISSING_PARAMETER\",\n \"errorCode\": \"MISSING_DETAILS_FETCH_PARAMETER\",\n \"message\": \"Missing required fields: customerIds\"\n}" }, { "label": "invalidFormat", "code": "// Invalid parameter format\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"INVALID_PARAMETER\",\n \"errorCode\": \"INVALID_CUSTOMER_IDS_FORMAT\",\n \"message\": \"Invalid format for customerIds parameter. Expected JSON array of strings.\"\n}" } ] }, { "id": "QmRVuCKxC7wB2ZFnEypoF", "language": "401", "code": "// Unauthorized - Authentication information is missing or invalid\n{\n \"status\": \"\",\n \"error\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Unauthorized - Authentication information is missing or invalid\n{\n \"status\": \"\",\n \"error\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n}" }, { "label": "missingApiKey", "code": "// Missing API key\n{\n \"status\": \"FAILURE\",\n \"errorCode\": \"MISSING_AUTH_METHOD\",\n \"errorType\": \"AUTHENTICATION_ERROR\",\n \"message\": \"No authentication method provided in the request.\"\n}" }, { "label": "invalidApiKey", "code": "// Invalid API key\n{\n \"status\": 401,\n \"error\": \"Unauthorized\",\n \"message\": \"Invalid api key invalid-key\"\n}" } ] }, { "id": "vE639v8ST2IqoNyqb0nXy", "language": "404", "code": "// Not Found - The requested resource was not found\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "subExamples": [ { "label": "GENERATED", "code": "// Not Found - The requested resource was not found\n{\n \"status\": \"\",\n \"errorType\": \"\",\n \"errorCode\": \"\",\n \"message\": \"\"\n}" }, { "label": "customerNotFound", "code": "// Customer not found\n{\n \"status\": \"FAILURE\",\n \"errorType\": \"NOT_FOUND\",\n \"errorCode\": \"CUSTOMER_NOT_FOUND\",\n \"message\": \"No customers found matching the provided customer IDs.\"\n}" } ] } ], "selectedLanguageId": "_0Y9vArL5gNMjV2MMlSVS" } }, "children": [ { "text": "" } ] }