Fetch customers
1 min
GET
https://api.nue.io/customers
Query Parameters
- customerIdsstringrequiredDescription
- includesstringDescriptionAllowedcontacts
Responses
200
- object
- statusstring<SUCCESS | PARTIAL_SUCCESS>DescriptionAllowedSUCCESSPARTIAL_SUCCESS
- dataobject[]Description
- accountNumberstringDescription
- accountSourcestring<Web | Phone Inquiry | Partner Referral | Purchased List | Other>DescriptionAllowedWebPhone InquiryPartner ReferralPurchased ListOther
- annualRevenuenumberDescription
- autoRenewstring<Yes | No | DefaultToSubscriptionConfiguration>DescriptionAllowedYesNoDefaultToSubscriptionConfiguration
- billCycleDaystring<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>DescriptionAllowed1st of Month2nd of Month3rd of Month4th of Month5th of Month6th of Month7th of Month8th of Month9th of Month10th of Month11th of Month12th of Month13th of Month14th of Month15th of Month16th of Month17th of Month18th of Month19th of Month20th of Month21st of Month22nd of Month23rd of Month24th of Month25th of Month26th of Month27th of Month28th of Month29th of Month30th of Month31st of Month
- billCycleStartMonthstring<01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12>DescriptionAllowed010203040506070809101112
- billingCitystringDescription
- billingCountrystringDescription
- billingPostalCodestringDescription
- billingStatestringDescription
- billingStreetstringDescription
- billingProrationEnabledstring<Yes | No>DescriptionAllowedYesNo
- companySizestringDescription
- createdByIdstringDescription
- createdDatestring<date-time>DescriptionFormatdate-time
- customerSincestring<date>DescriptionFormatdate
- descriptionstringDescription
- eInvoicingEndpointIdstringDescription
- eInvoicingSchemaIdstringDescription
- emailstring<email>DescriptionFormatemail
- entityIdstringDescription
- entityUseCodestringDescription
- faxstringDescription
- fundingstringDescription
- idstringDescription
- imageSignedUrlstring<url>DescriptionFormaturl
- industrystring<Agriculture | Apparel | Banking | Biotechnology | Chemicals | Communications | Construction | Consulting | Education | Electronics | Energy | Engineering | Entertainment | Environmental | Finance | Food & Beverage | Government | Healthcare | Hospitality | Insurance | Machinery | Manufacturing | Media | Not For Profit | Recreation | Retail | Shipping | Technology | Telecommunications | Transportation | Utilities | Other>DescriptionAllowedAgricultureApparelBankingBiotechnologyChemicalsCommunicationsConstructionConsultingEducationElectronicsEnergyEngineeringEntertainmentEnvironmentalFinanceFood & BeverageGovernmentHealthcareHospitalityInsuranceMachineryManufacturingMediaNot For ProfitRecreationRetailShippingTechnologyTelecommunicationsTransportationUtilitiesOther
- invoiceBalancenumberDescription
- lastInvoiceDatestring<date>DescriptionFormatdate
- lastModifiedByIdstringDescription
- lastModifiedDatestring<date-time>DescriptionFormatdate-time
- latestOrderDatestring<date>DescriptionFormatdate
- legalEntityNamestringDescription
- namestringDescription
- numberOfEmployeesintegerDescription
- orderPrimaryContactIdstringDescription
- ownershipstring<Public | Private | Subsidiary | Other>DescriptionAllowedPublicPrivateSubsidiaryOther
- parentCustomerIdstringDescription
- paymentMethodstring<ACH | Credit Card | Wire Transfer | Debit Card | Paypal | Other>DescriptionAllowedACHCredit CardWire TransferDebit CardPaypalOther
- paymentMethodsstring[]Description
- paymentTermstring<Net 15 | Net 30 | Net 45 | Net 60>DescriptionAllowedNet 15Net 30Net 45Net 60
- phonestringDescription
- recordTypestringDescription
- salesAccountIdstringDescription
- shippingCitystringDescription
- shippingCountrystringDescription
- shippingPostalCodestringDescription
- shippingStatestringDescription
- shippingStreetstringDescription
- sitestringDescription
- taxExemptstring<none | exempt | reverse>DescriptionAllowednoneexemptreverse
- timezonestring<Pacific/Kiritimati | UTC | GMT | Pacific/Apia | Pacific/Enderbury | Pacific/Fakaofo | Pacific/Tongatapu | Pacific/Chatham | Antarctica/McMurdo | Asia/Anadyr | Asia/Kamchatka | Pacific/Auckland | Pacific/Fiji | Pacific/Funafuti | Pacific/Kwajalein | Pacific/Majuro | Pacific/Nauru | Pacific/Tarawa | Pacific/Wake | Pacific/Wallis | Antarctica/Casey | Asia/Magadan | Asia/Sakhalin | Asia/Srednekolymsk | Pacific/Bougainville | Pacific/Efate | Pacific/Guadalcanal | Pacific/Kosrae | Pacific/Norfolk | Pacific/Noumea | Pacific/Ponape | Australia/Lord_Howe | Antarctica/DumontDUrville | Antarctica/Macquarie | Asia/Ust-Nera | Asia/Vladivostok | Australia/Brisbane | Australia/Currie | Australia/Hobart | Australia/Lindeman | Australia/Melbourne | Australia/Sydney | Pacific/Guam | Pacific/Port_Moresby | Pacific/Saipan | Pacific/Truk | Australia/Adelaide | Australia/Broken_Hill | Australia/Darwin | Asia/Chita | Asia/Dili | Asia/Jayapura | Asia/Khandyga | Asia/Pyongyang | Asia/Seoul | Asia/Tokyo | Asia/Yakutsk | Pacific/Palau | Australia/Eucla | Asia/Brunei | Asia/Choibalsan | Asia/Hong_Kong | Asia/Irkutsk | Asia/Kuala_Lumpur | Asia/Kuching | Asia/Macau | Asia/Makassar | Asia/Manila | Asia/Shanghai | Asia/Singapore | Asia/Taipei | Asia/Ulaanbaatar | Australia/Perth | Antarctica/Davis | Asia/Bangkok | Asia/Barnaul | Asia/Ho_Chi_Minh | Asia/Hovd | Asia/Jakarta | Asia/Krasnoyarsk | Asia/Novokuznetsk | Asia/Novosibirsk | Asia/Phnom_Penh | Asia/Pontianak | Asia/Tomsk | Asia/Vientiane | Indian/Christmas | Asia/Rangoon | Indian/Cocos | Antarctica/Vostok | Asia/Almaty | Asia/Bishkek | Asia/Dhaka | Asia/Omsk | Asia/Qostanay | Asia/Thimphu | Asia/Urumqi | Indian/Chagos | Asia/Kathmandu | Asia/Colombo | Asia/Kolkata | Antarctica/Mawson | Asia/Aqtau | Asia/Aqtobe | Asia/Ashgabat | Asia/Atyrau | Asia/Dushanbe | Asia/Karachi | Asia/Oral | Asia/Qyzylorda | Asia/Samarkand | Asia/Tashkent | Asia/Yekaterinburg | Indian/Kerguelen | Indian/Maldives | Asia/Kabul | Asia/Baku | Asia/Dubai | Asia/Muscat | Asia/Tbilisi | Asia/Yerevan | Europe/Astrakhan | Europe/Samara | Europe/Saratov | Europe/Ulyanovsk | Indian/Mahe | Indian/Mauritius | Indian/Reunion | Asia/Tehran | Africa/Addis_Ababa | Africa/Asmera | Africa/Dar_es_Salaam | Africa/Djibouti | Africa/Kampala | Africa/Mogadishu | Africa/Nairobi | Antarctica/Syowa | Asia/Aden | Asia/Baghdad | Asia/Bahrain | Asia/Kuwait | Asia/Qatar | Asia/Riyadh | Europe/Istanbul | Europe/Kirov | Europe/Minsk | Europe/Moscow | Europe/Simferopol | Europe/Volgograd | Indian/Antananarivo | Indian/Comoro | Indian/Mayotte | Africa/Blantyre | Africa/Bujumbura | Africa/Cairo | Africa/Gaborone | Africa/Harare | Africa/Johannesburg | Africa/Juba | Africa/Khartoum | Africa/Kigali | Africa/Lubumbashi | Africa/Lusaka | Africa/Maputo | Africa/Maseru | Africa/Mbabane | Africa/Tripoli | Africa/Windhoek | Asia/Amman | Asia/Beirut | Asia/Damascus | Asia/Famagusta | Asia/Gaza | Asia/Hebron | Asia/Jerusalem | Asia/Nicosia | Europe/Athens | Europe/Bucharest | Europe/Chisinau | Europe/Helsinki | Europe/Kaliningrad | Europe/Kiev | Europe/Mariehamn | Europe/Riga | Europe/Sofia | Europe/Tallinn | Europe/Uzhgorod | Europe/Vilnius | Europe/Zaporozhye | Africa/Algiers | Africa/Bangui | Africa/Brazzaville | Africa/Ceuta | Africa/Douala | Africa/Kinshasa | Africa/Lagos | Africa/Libreville | Africa/Luanda | Africa/Malabo | Africa/Ndjamena | Africa/Niamey | Africa/Porto-Novo | Africa/Tunis | Arctic/Longyearbyen | Europe/Amsterdam | Europe/Andorra | Europe/Belgrade | Europe/Berlin | Europe/Bratislava | Europe/Brussels | Europe/Budapest | Europe/Busingen | Europe/Copenhagen | Europe/Gibraltar | Europe/Ljubljana | Europe/Luxembourg | Europe/Madrid | Europe/Malta | Europe/Monaco | Europe/Oslo | Europe/Paris | Europe/Podgorica | Europe/Prague | Europe/Rome | Europe/San_Marino | Europe/Sarajevo | Europe/Skopje | Europe/Stockholm | Europe/Tirane | Europe/Vaduz | Europe/Vatican | Europe/Vienna | Europe/Warsaw | Europe/Zagreb | Europe/Zurich | Africa/Abidjan | Africa/Accra | Africa/Bamako | Africa/Banjul | Africa/Bissau | Africa/Casablanca | Africa/Conakry | Africa/Dakar | Africa/El_Aaiun | Africa/Freetown | Africa/Lome | Africa/Monrovia | Africa/Nouakchott | Africa/Ouagadougou | Africa/Sao_Tome | America/Danmarkshavn | Antarctica/Troll | Atlantic/Canary | Atlantic/Faeroe | Atlantic/Madeira | Atlantic/Reykjavik | Atlantic/St_Helena | Europe/Dublin | Europe/Guernsey | Europe/Isle_of_Man | Europe/Jersey | Europe/Lisbon | Europe/London | GMT | America/Scoresbysund | Atlantic/Azores | Atlantic/Cape_Verde | America/Noronha | Atlantic/South_Georgia | America/Araguaina | America/Argentina/Buenos_Aires | America/Argentina/La_Rioja | America/Argentina/Rio_Gallegos | America/Argentina/Salta | America/Argentina/San_Juan | America/Argentina/San_Luis | America/Argentina/Tucuman | America/Argentina/Ushuaia | America/Bahia | America/Belem | America/Catamarca | America/Cayenne | America/Cordoba | America/Fortaleza | America/Godthab | America/Jujuy | America/Maceio | America/Mendoza | America/Miquelon | America/Montevideo | America/Paramaribo | America/Punta_Arenas | America/Recife | America/Santarem | America/Sao_Paulo | Antarctica/Palmer | Antarctica/Rothera | Atlantic/Stanley | America/St_Johns | America/Anguilla | America/Antigua | America/Aruba | America/Asuncion | America/Barbados | America/Blanc-Sablon | America/Boa_Vista | America/Campo_Grande | America/Caracas | America/Cuiaba | America/Curacao | America/Dominica | America/Glace_Bay | America/Goose_Bay | America/Grenada | America/Guadeloupe | America/Guyana | America/Halifax | America/Kralendijk>DescriptionAllowedPacific/KiritimatiUTCGMTPacific/ApiaPacific/EnderburyPacific/FakaofoPacific/TongatapuPacific/ChathamAntarctica/McMurdoAsia/AnadyrAsia/KamchatkaPacific/AucklandPacific/FijiPacific/FunafutiPacific/KwajaleinPacific/MajuroPacific/NauruPacific/TarawaPacific/WakePacific/WallisAntarctica/CaseyAsia/MagadanAsia/SakhalinAsia/SrednekolymskPacific/BougainvillePacific/EfatePacific/GuadalcanalPacific/KosraePacific/NorfolkPacific/NoumeaPacific/PonapeAustralia/Lord_HoweAntarctica/DumontDUrvilleAntarctica/MacquarieAsia/Ust-NeraAsia/VladivostokAustralia/BrisbaneAustralia/CurrieAustralia/HobartAustralia/LindemanAustralia/MelbourneAustralia/SydneyPacific/GuamPacific/Port_MoresbyPacific/SaipanPacific/TrukAustralia/AdelaideAustralia/Broken_HillAustralia/DarwinAsia/ChitaAsia/DiliAsia/JayapuraAsia/KhandygaAsia/PyongyangAsia/SeoulAsia/TokyoAsia/YakutskPacific/PalauAustralia/EuclaAsia/BruneiAsia/ChoibalsanAsia/Hong_KongAsia/IrkutskAsia/Kuala_LumpurAsia/KuchingAsia/MacauAsia/MakassarAsia/ManilaAsia/ShanghaiAsia/SingaporeAsia/TaipeiAsia/UlaanbaatarAustralia/PerthAntarctica/DavisAsia/BangkokAsia/BarnaulAsia/Ho_Chi_MinhAsia/HovdAsia/JakartaAsia/KrasnoyarskAsia/NovokuznetskAsia/NovosibirskAsia/Phnom_PenhAsia/PontianakAsia/TomskAsia/VientianeIndian/ChristmasAsia/RangoonIndian/CocosAntarctica/VostokAsia/AlmatyAsia/BishkekAsia/DhakaAsia/OmskAsia/QostanayAsia/ThimphuAsia/UrumqiIndian/ChagosAsia/KathmanduAsia/ColomboAsia/KolkataAntarctica/MawsonAsia/AqtauAsia/AqtobeAsia/AshgabatAsia/AtyrauAsia/DushanbeAsia/KarachiAsia/OralAsia/QyzylordaAsia/SamarkandAsia/TashkentAsia/YekaterinburgIndian/KerguelenIndian/MaldivesAsia/KabulAsia/BakuAsia/DubaiAsia/MuscatAsia/TbilisiAsia/YerevanEurope/AstrakhanEurope/SamaraEurope/SaratovEurope/UlyanovskIndian/MaheIndian/MauritiusIndian/ReunionAsia/TehranAfrica/Addis_AbabaAfrica/AsmeraAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/KampalaAfrica/MogadishuAfrica/NairobiAntarctica/SyowaAsia/AdenAsia/BaghdadAsia/BahrainAsia/KuwaitAsia/QatarAsia/RiyadhEurope/IstanbulEurope/KirovEurope/MinskEurope/MoscowEurope/SimferopolEurope/VolgogradIndian/AntananarivoIndian/ComoroIndian/MayotteAfrica/BlantyreAfrica/BujumburaAfrica/CairoAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KhartoumAfrica/KigaliAfrica/LubumbashiAfrica/LusakaAfrica/MaputoAfrica/MaseruAfrica/MbabaneAfrica/TripoliAfrica/WindhoekAsia/AmmanAsia/BeirutAsia/DamascusAsia/FamagustaAsia/GazaAsia/HebronAsia/JerusalemAsia/NicosiaEurope/AthensEurope/BucharestEurope/ChisinauEurope/HelsinkiEurope/KaliningradEurope/KievEurope/MariehamnEurope/RigaEurope/SofiaEurope/TallinnEurope/UzhgorodEurope/VilniusEurope/ZaporozhyeAfrica/AlgiersAfrica/BanguiAfrica/BrazzavilleAfrica/CeutaAfrica/DoualaAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LuandaAfrica/MalaboAfrica/NdjamenaAfrica/NiameyAfrica/Porto-NovoAfrica/TunisArctic/LongyearbyenEurope/AmsterdamEurope/AndorraEurope/BelgradeEurope/BerlinEurope/BratislavaEurope/BrusselsEurope/BudapestEurope/BusingenEurope/CopenhagenEurope/GibraltarEurope/LjubljanaEurope/LuxembourgEurope/MadridEurope/MaltaEurope/MonacoEurope/OsloEurope/ParisEurope/PodgoricaEurope/PragueEurope/RomeEurope/San_MarinoEurope/SarajevoEurope/SkopjeEurope/StockholmEurope/TiraneEurope/VaduzEurope/VaticanEurope/ViennaEurope/WarsawEurope/ZagrebEurope/ZurichAfrica/AbidjanAfrica/AccraAfrica/BamakoAfrica/BanjulAfrica/BissauAfrica/CasablancaAfrica/ConakryAfrica/DakarAfrica/El_AaiunAfrica/FreetownAfrica/LomeAfrica/MonroviaAfrica/NouakchottAfrica/OuagadougouAfrica/Sao_TomeAmerica/DanmarkshavnAntarctica/TrollAtlantic/CanaryAtlantic/FaeroeAtlantic/MadeiraAtlantic/ReykjavikAtlantic/St_HelenaEurope/DublinEurope/GuernseyEurope/Isle_of_ManEurope/JerseyEurope/LisbonEurope/LondonGMTAmerica/ScoresbysundAtlantic/AzoresAtlantic/Cape_VerdeAmerica/NoronhaAtlantic/South_GeorgiaAmerica/AraguainaAmerica/Argentina/Buenos_AiresAmerica/Argentina/La_RiojaAmerica/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_JuanAmerica/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/UshuaiaAmerica/BahiaAmerica/BelemAmerica/CatamarcaAmerica/CayenneAmerica/CordobaAmerica/FortalezaAmerica/GodthabAmerica/JujuyAmerica/MaceioAmerica/MendozaAmerica/MiquelonAmerica/MontevideoAmerica/ParamariboAmerica/Punta_ArenasAmerica/RecifeAmerica/SantaremAmerica/Sao_PauloAntarctica/PalmerAntarctica/RotheraAtlantic/StanleyAmerica/St_JohnsAmerica/AnguillaAmerica/AntiguaAmerica/ArubaAmerica/AsuncionAmerica/BarbadosAmerica/Blanc-SablonAmerica/Boa_VistaAmerica/Campo_GrandeAmerica/CaracasAmerica/CuiabaAmerica/CuracaoAmerica/DominicaAmerica/Glace_BayAmerica/Goose_BayAmerica/GrenadaAmerica/GuadeloupeAmerica/GuyanaAmerica/HalifaxAmerica/Kralendijk
- todayARRnumberDescription
- todayCMRRnumberDescription
- todayRollupARRnumberDescription
- todayRollupCMRRnumberDescription
- totalTCVnumberDescription
- typestring<Prospect | Customer - Direct | Customer - Channel | Channel Partner / Reseller | Installation Partner | Technology Partner | Other>DescriptionAllowedProspectCustomer - DirectCustomer - ChannelChannel Partner / ResellerInstallation PartnerTechnology PartnerOther
- websitestring<url>DescriptionFormaturl
- warningsobject[]Description
- codestringDescription
- messagestringDescription
400
- ErrorResponse
- statusstring<FAILURE>requiredDescriptionAllowedFAILURE
- errorTypestring<NOT_FOUND | INVALID_PARAMETER | MISSING_PARAMETER | INVALID_ARGUMENT | AUTHENTICATION_ERROR>DescriptionAllowedNOT_FOUNDINVALID_PARAMETERMISSING_PARAMETERINVALID_ARGUMENTAUTHENTICATION_ERROR
- errorCodestring<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>DescriptionAllowedMISSING_DETAILS_FETCH_PARAMETERMISSING_FETCH_PARAMETERINVALID_CUSTOMER_IDS_FORMATINVALID_PARAMETER_COMBINATIONORDER_UNKNOWN_FIELDCUSTOMER_NOT_FOUNDMISSING_AUTH_METHODINSUFFICIENT_PERMISSIONSINVALID_JSON
- messagestringrequiredDescription
401
- UnauthorizedErrorDescription
- statusDescription
- errorstringDescription
- errorCodestringDescription
- errorTypestringDescription
- messagestringDescription
404
- ErrorResponse
- statusstring<FAILURE>requiredDescriptionAllowedFAILURE
- errorTypestring<NOT_FOUND | INVALID_PARAMETER | MISSING_PARAMETER | INVALID_ARGUMENT | AUTHENTICATION_ERROR>DescriptionAllowedNOT_FOUNDINVALID_PARAMETERMISSING_PARAMETERINVALID_ARGUMENTAUTHENTICATION_ERROR
- errorCodestring<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>DescriptionAllowedMISSING_DETAILS_FETCH_PARAMETERMISSING_FETCH_PARAMETERINVALID_CUSTOMER_IDS_FORMATINVALID_PARAMETER_COMBINATIONORDER_UNKNOWN_FIELDCUSTOMER_NOT_FOUNDMISSING_AUTH_METHODINSUFFICIENT_PERMISSIONSINVALID_JSON
- messagestringrequiredDescription
curl
curl --request GET \
--url 'https://api.nue.io/customers?customerIds=string' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/customers?customerIds=string", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/customers?customerIds=string")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/customers?customerIds=string"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successfully retrieved customer information
{
"status": "",
"data": [
{
"accountNumber": "",
"accountSource": "",
"annualRevenue": 0,
"autoRenew": "",
"billCycleDay": "",
"billCycleStartMonth": "",
"billingCity": "",
"billingCountry": "",
"billingPostalCode": "",
"billingState": "",
"billingStreet": "",
"billingProrationEnabled": "",
"companySize": "",
"createdById": "",
"createdDate": "",
"customerSince": "",
"description": "",
"eInvoicingEndpointId": "",
"eInvoicingSchemaId": "",
"email": "",
"entityId": "",
"entityUseCode": "",
"fax": "",
"funding": "",
"id": "",
"imageSignedUrl": "",
"industry": "",
"invoiceBalance": 0,
"lastInvoiceDate": "",
"lastModifiedById": "",
"lastModifiedDate": "",
"latestOrderDate": "",
"legalEntityName": "",
"name": "",
"numberOfEmployees": 0,
"orderPrimaryContactId": "",
"ownership": "",
"parentCustomerId": "",
"paymentMethod": "",
"paymentMethods": [
""
],
"paymentTerm": "",
"phone": "",
"recordType": "",
"salesAccountId": "",
"shippingCity": "",
"shippingCountry": "",
"shippingPostalCode": "",
"shippingState": "",
"shippingStreet": "",
"site": "",
"taxExempt": "",
"timezone": "",
"todayARR": 0,
"todayCMRR": 0,
"todayRollupARR": 0,
"todayRollupCMRR": 0,
"totalTCV": 0,
"type": "",
"website": ""
}
],
"warnings": [
{
"code": "",
"message": ""
}
]
}400
// Bad Request - The request was malformed or contained invalid parameters
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}GENERATED
// Bad Request - The request was malformed or contained invalid parameters
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}missingParameter
// Missing required parameter
{
"status": "FAILURE",
"errorType": "MISSING_PARAMETER",
"errorCode": "MISSING_DETAILS_FETCH_PARAMETER",
"message": "Missing required fields: customerIds"
}invalidFormat
// Invalid parameter format
{
"status": "FAILURE",
"errorType": "INVALID_PARAMETER",
"errorCode": "INVALID_CUSTOMER_IDS_FORMAT",
"message": "Invalid format for customerIds parameter. Expected JSON array of strings."
}401
// Unauthorized - Authentication information is missing or invalid
{
"status": "",
"error": "",
"errorCode": "",
"errorType": "",
"message": ""
}GENERATED
// Unauthorized - Authentication information is missing or invalid
{
"status": "",
"error": "",
"errorCode": "",
"errorType": "",
"message": ""
}missingApiKey
// Missing API key
{
"status": "FAILURE",
"errorCode": "MISSING_AUTH_METHOD",
"errorType": "AUTHENTICATION_ERROR",
"message": "No authentication method provided in the request."
}invalidApiKey
// Invalid API key
{
"status": 401,
"error": "Unauthorized",
"message": "Invalid api key invalid-key"
}404
// Not Found - The requested resource was not found
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}GENERATED
// Not Found - The requested resource was not found
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}customerNotFound
// Customer not found
{
"status": "FAILURE",
"errorType": "NOT_FOUND",
"errorCode": "CUSTOMER_NOT_FOUND",
"message": "No customers found matching the provided customer IDs."
}