{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d4b2f432-ee61-488e-92eb-63944bad9690","name":"Domo Documentation","description":"# Introduction\n\nThe Domo Product APIs are the APIs that drive the entire Domo platform behind the scenes. Anything you can do via the user interface in Domo can be done via the Product APIs. The official documentation for these APIs can be found here: [Domo Developer - Product APIs Overview](https://developer.domo.com/portal/8ba9aedad3679-ap-is#product-apis). Now that I am a Domo employee, I will be working with them to pull my efforts into the official documentation over time. But, we wanted to provide the community with this information ASAP, which is why this Postman collection is being shared outside of the official documentation.\n\n# Disclaimer\n\nThis Postman collection is unofficial and not provided by Domo, Inc. I have been given permission by Domo to share this Postman collection with the Domo Community. However, use of this Postman collection is at your own risk. The Product APIs are subject to change without notice. You are responsible for anything done using these APIs. It is recommended to use them in a sandbox environment first so you don't accidentally mess up something in production. And it is not recommended to ever use these APIs with system critical processes.\n\nWhile this Postman collection is extensive, it isn't 100% comprehensive. Some endpoints and possible field values are missing. Most endpoints don't have response examples yet. I plan to continue to update this collection over time. If you fork this collection, you can pull these new updates as they become available to merge into your fork. You can also explore the Product APIs yourself by using a combination of this collection and the developer tools network console in your browser while in Domo. You can learn more about the developer tools in Google Chrome [here](https://developer.chrome.com/docs/devtools/overview#network).\n\n# Setup\n\n## Authentication\n\nAuthenticating to the Product APIs is achieved with an access token. This access token must be sent with every API request as the value to the header X-DOMO-Developer-Token. You can learn more about creating and managing access tokens [here](https://domo-support.domo.com/s/article/360042934494?language=en_US). In this collection, you can update the value of the variable X-DOMO-Developer-Token to have it included properly in your requests. You can do this by adding the access token to your Postman Vault (recommended), setting the value of the variable directly under the variables tab in this collection, or by creating an environment variable.\n\n## Instance\n\nYou must also set the value of the variable instance to properly ping your environment with this collection. You can find the value of instance by visitng your Domo environment in your browser, and copying the URL part between **https://** and **.domo.com**. You can either update the variable directly under the variables tab in this collection or by creating an environment variable to overwrite it.\n\n## Fork\n\nTo use the collection, you will need to fork it so you have a version saved to your own Postman account and workspace. Forking allows you to then modify the collection as you see fit, including saving responses as examples, adding specific IDs relevant to your environment, etc. As I update this collection over time, you can pull the updates from this main collection to your fork, and merge them how you see fit with any modifications you've made.\n\n# Help\n\nI've tried my best to document each endpoint using Postman's new [types feature](https://learning.postman.com/docs/design-apis/collections/view-properties-and-documentation/) as well as some written documentation. I plan to further the documentation over time. If you have questions or need additional help, the [Domo Community Forum](https://community-forums.domo.com/main/discussions) and [Domo User Group Slack](https://domousergroup.carrd.co/) are great resources. You can also send me a DM on the Domo User Group Slack.\n\n# Format\n\nThe folders in this collection are ordered alphabetically. The folders are named according to how they are referenced in the API endpoint. Sometimes, these terms don't match what you see in Domo. In those cases, I have added parentheses following the name that contain the common term used in the Domo user interface e.g., Pages (Dashboards).\n\nWithin each folder, endpoints are ordered top to bottom by the following categories, then by relevance within those:\n\n1. Subfolders\n    \n2. List/Search\n    \n3. Get\n    \n4. Operation (e.g., Share, Run, etc.)\n    \n5. Create\n    \n6. Update\n    \n7. Delete\n    \n\n---\n\n## Merged Collection\n\nThis collection combines:\n\n- **Domo Product APIs** - Comprehensive API coverage with clean variable structure\n    \n- **Domo Documentation** - Authenticated endpoints organized by authentication type\n    \n\nAll variables have been standardized to use the Product APIs structure:\n\n- `instance`: Your Domo instance name\n    \n- `instanceUrl`: https://{{instance}}.domo.com\n    \n- `baseUrl`: {{instanceUrl}}/api","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"5049119","team":352341,"collectionId":"d4b2f432-ee61-488e-92eb-63944bad9690","publishedId":"UyxbppB2","public":true,"publicUrl":"https://postman.datacrew.space","privateUrl":"https://go.postman.co/documentation/5049119-d4b2f432-ee61-488e-92eb-63944bad9690","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Domo API documentatation"},{"name":"title","value":"DataCrew (unofficial) Domo 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":"EF5B25"}}]}},"version":"8.10.1","publishDate":"2026-01-04T20:07:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"DataCrew (unofficial) Domo API Documentation","description":"Domo API documentatation"},"logos":{"logoLight":null,"logoDark":null}},"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/8281007496f30be5ba29c9909dea29d59715805c5dad896f2ef9e8c22e0c1e8d","favicon":"https://res.cloudinary.com/postman/image/upload/v1651692055/team/b7ata47fx3mgwmmck6fk.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://postman.datacrew.space/view/metadata/UyxbppB2"}