{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e18f650f-932d-4bae-b6dd-a2edcc0b221f","name":"CARTO API","description":"<img src=\"https://storage.googleapis.com/postman_doc_assets/developer-api-header.png\">\n\nThe CARTO API lets you interact with your data in an external data warehouse using a existing connection in your CARTO organization. Learn more about connections [here](https://docs.carto.com/carto-user-manual/overview/getting-started/#create-a-connection).\n\n## Authorization\n\n#### Getting an API Access Token\n\nFor **Maps API**, **SQL API**, **Imports API**, and **LDS API**, you can use an API Access Token that grants access to a specific resource from a CARTO connection\n\nPlease check [this documentation](https://docs.carto.com/carto-user-manual/developers/api-access-tokens) to learn how to get an API Access Token.\n\n#### Getting an OAuth Access Token\n\nAll APIs can be used with an OAuth Access Token, which represents a specific user.\n\nThe **Tokens API**, **Named Sources API**, **Resources API,** and **Activity Data API** work exclusively with this type of token. To obtain one, create an OAuth Client in your CARTO account Developers section and use the `clientSecret` and `clientID` variables. This collection uses a pre-request script that handle this process before each request.\n\nCheck [this documentation](https://docs.carto.com/carto-user-manual/developers/managing-applications#managing-built-applications) to learn more about OAuth Clients.\n\nIf you need to obtain an OAuth Access Token manually, here is a cURL example:\n\n``` bash\ncurl --request POST \\\n  --url 'https://auth.carto.com/oauth/token' \\\n  --header 'content-type: application/x-www-form-urlencoded' \\\n  --data 'grant_type=client_credentials' \\\n  --data 'client_id={{clientID}}' \\\n  --data 'client_secret={{clientSecret}}' \\\n  --data 'audience=carto-cloud-native-api'\n\n ```\n\n## API Base URL\n\nThis collection uses an environmental variable to define the API Base URL.  \nGo to the \"Documentation\" environment configuration and set the `apiBaseURL` variable according with the information that you will find in the Developers section of your CARTO account's Workspace. For example:  \n`https://gcp-us-east1.api.carto.com`\n\n## Using this Postman collection\n\nThe CARTO API complete reference is available at [api-docs.carto.com](https://api-docs.carto.com) as a Postman collection that you can explore interactively by clicking on the _Run in Postman_ button.\n\n- Go to [api-docs.carto.com](https://api-docs.carto.com) and click on _Run in Postman_\n    \n- Import the Collection in one of your Postman Workspaces\n    \n- Configure your Environment:\n    \n    - Click on Environments\n        \n    - Select _Documentation_\n        \n    - Set the variables `apiBaseURL`, and `apiAccessToken` with the values that you will find in the Developers section of your CARTO account.\n        \n- You are all set! Select a folder in the collection and run the example requests.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17238803","collectionId":"e18f650f-932d-4bae-b6dd-a2edcc0b221f","publishedId":"U16eu86C","public":true,"publicUrl":"https://api-docs.carto.com","privateUrl":"https://go.postman.co/documentation/17238803-e18f650f-932d-4bae-b6dd-a2edcc0b221f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentation about CARTO API endpoints. Maps API, SQL API, Import API, Connections API, Tokens API and LDS API"},{"name":"title","value":"CARTO API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2023-04-19T15:27:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"CARTO API Documentation","description":"Documentation about CARTO API endpoints. Maps API, SQL API, Import API, Connections API, Tokens API and LDS API"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Documentation","id":"2ffffde5-6660-4680-87b7-f3f0346ad6ca","owner":"16126841","values":[{"key":"apiAccessToken","value":"","enabled":true,"type":"default"},{"key":"apiBaseURL","value":"https://gcp-us-east1.api.carto.com","enabled":true},{"key":"authServer","value":"https://auth.carto.com","enabled":true},{"key":"clientId","value":"","enabled":true},{"key":"clientSecret","value":"","enabled":true},{"key":"accessToken","value":"","enabled":true},{"key":"accountsURL","value":"https://accounts.app.carto.com","enabled":true,"type":"default"}],"published":true}],"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/a4a816d3464d46de2fa9c269e005ca62eac58578d19fafc8660b49ff756160a5","favicon":"https://carto.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"},{"label":"Documentation","value":"16126841-2ffffde5-6660-4680-87b7-f3f0346ad6ca"}],"canonicalUrl":"https://api-docs.carto.com/view/metadata/U16eu86C"}