{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"beb9ccb8-4e1d-4d3c-9597-1423b1f00303","name":"AutoVision API","description":"## <u>About AutoVision</u>\n\nAutoVision is a unified dealer management software platform built from the ground up for dealers and automotive companies of all shapes and sizes to automate and optimize their car buying, selling, and vehicle inventory management with a modular suite of interlocking tools, APIs and deep statistical insights.\n\n## <u>Getting Access</u>\n\nYou must be an AutoVision customer to use the AutoVision API. If you are not already a customer, contact us here: [https://www.autovision.com/contact-autovision](https://www.autovision.com/contact-autovisionIf)\n\nIf you are an existing customer and would like direct access to the API, contact your sales or support representative directly.\n\n# <u>Getting Started</u>\n\nIn order to make requests to the AutoVision API you will need to be provided with:\n\n- An AutoVision Account\n    \n- An API hostname\n    \n- An API Key & CompanyId for your Account\n    \n- A list of Scopes your Account and API key are authorized for\n    \n\n### <u>Authentication &amp; Authorization</u>\n\n#### API Key\n\nAPI Key must be placed in every request header.\n\n#### Access Rights (Account & Scope)\n\nYour API key may be used to make requests for your AutoVision Account and any authorized Sub-Accounts.\n\nVia Scopes, your Account and API key will be authorized for specific API methods, and in the context of individual API methods, may be authorized for some or all response data elements.\n\nWhen executing any API method, the primary Scope required for the method must be specified. Sub-scopes specified will determine whether subordinate data elements are returned in the response.\n\nAny API request will fail if any Scope specified in the request is not authorized for the specified Account (identified by CompanyId) and API Key.\n\n#### Postman Setup\n\nIf you are using Postman, configure the API hostname, API Key, and CompanyId you received in the appropriate Variables in the collection. The variables are setup at the collection level so you should not have to specify them on every request.\n\n### <u>Request Format</u>\n\n#### Request URI\n\nAll URIs are structured like the following:\n\nhttps://**\\[Hostname\\]**/api/public/**\\[Version\\]**/**\\[CompanyId\\]**/some-method-specific-uri\n\n- **Hostname**: Specific to staging vs. production environments\n    \n- **Version**: API version (Currently **v2.** Individual API methods may be versioned independently in the future)\n    \n- **CompanyId**: CompanyId for the AutoVision Account to which your API Key was assigned\n    \n\n#### Request Content\n\nUnless otherwise noted, all requests are:\n\n- **Http Method**: POST\n    \n- **Required HTTP Headers**:\n    - api-key: \\[your-api-key\\]\n        \n    - Content-Type: application/json\n        \n- **Request Body**: JSON request object\n    \n\n#### Request Body\n\nAll JSON requests will have a similar structure, although Sopes and Request format will be method-specific.\n\n``` json\n{\n    \"Scopes\": [\n        \"[primary-scope]\",\n        \"[optionally-one-or-more-sub-scopes\",\n    ],\n    \"Request\": {\n    }\n}\n\n ```\n\n### <u>Response Format</u>\n\nAll API requests should return HTTP 200 responses unless the API is unavailable (e.g. for maintenance).\n\n#### Response Body\n\nAll JSON responses will have a similar structure, although Response format will be method-specific. Failed requests will return only the Errors node. Successful requests will return only the Response node.\n\n``` json\n{\n    \"errors\": [\n    ],\n    \"response\": {\n    }\n}\n\n ```\n\n#### Error Response Definition\n\n- **errors** object: Errors object.\n    - **code** int: Error code. Will correspond to standard HTTP error codes unless otherwise specified\n        \n    - **message** string: Error message\n        \n    - **detail** string: Error details","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"25882430","team":4696097,"collectionId":"beb9ccb8-4e1d-4d3c-9597-1423b1f00303","publishedId":"2s93CHvbN5","public":true,"publicUrl":"https://api-docs.autovision.com","privateUrl":"https://go.postman.co/documentation/25882430-beb9ccb8-4e1d-4d3c-9597-1423b1f00303","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-02-20T17:25:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/654ffc92075c9359370dadf699e2463eacd8435a0f61b292f7f197bee7e9c38f","favicon":"https://autovision.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs.autovision.com/view/metadata/2s93CHvbN5"}