{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fd0e0781-31e2-4ebd-b0b5-e332448efc6f","name":"Sugar RESTful API Collection","description":"# SugarCRM RESTful API – Official Collection\n\nThis is the official RESTful API collection for **Sugar Sell**, **Sugar Serve**, and **Sugar Enterprise**.\n\nFor comprehensive API documentation, visit: [https://apidocs.sugarcrm.com/](https://apidocs.sugarcrm.com/)\n\n---\n\n## Collection Structure\n\nTo make the API easier to explore and use, this collection is organized into folders based on functionality and real-world usage patterns:\n\n- **Authorization**  \n    Contains endpoints required for authenticating with the SugarCRM API, including token generation and refresh. Start here when connecting your application.\n    \n- **Modules CRUD**  \n    Core endpoints for Create, Read, Update, and Delete operations across all modules. These are designed to be module-agnostic and cover the fundamental operations available for all Sugar modules.\n    \n- **Use Cases**  \n    Real-world examples grouped by business scenarios or performance considerations. These include optimized patterns for bulk operations, upserts, dashboard manipulation, and other common tasks in a typical Sugar implementation.\n    \n\nThis folder structure is intended to help both new and experienced developers quickly find what they need—whether you're building from scratch, optimizing an existing integration, or solving a specific problem.\n\n---\n\n## REST API Versioning\n\nAPI versioning allows SugarCRM to introduce new functionality via new endpoints, while maintaining compatibility with existing integrations. This ensures a safe and upgrade-friendly experience for developers.\n\n---\n\n## Base REST API URL\n\nTo connect to the Sugar REST API, use the following format:  \n**https://:instance_url/rest/:rest_version**\n\n### Token-Based Authentication\n\nTo obtain a token, make a request against the following endpoint providing your username, domain, and password as a JSON blob:\n\nHere’s a CURL:\n\n``` shell\ncurl -X POST -H Cache-Control:no-cache -H \"Content-Type: application/json\" -d '{ \n    \"grant_type\":\"password\", \n    \"client_id\":\"sugar\", \n    \"client_secret\":\"\", \n    \"username\":\"<username>\", \n    \"password\":\"<password>\", \n    \"platform\":\"custom\" \n}&#x27; https:/<instance_url>/rest/<rest_version>/oauth2/token\n\n ```\n\nResponse will look as follows:\n\n``` json\n{\n    \"access_token\": \"5ee48ec7-023e-ecff-5184-530bd0358868\",\n    \"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": null,\n    \"refresh_token\": \"5f197357-0167-f7a6-7912-530bd03275b6\",\n    \"refresh_expires_in\": 1209600,\n    \"download_token\": \"5f531625-e301-e3ea-1b11-530bd098be41\"\n}\n\n ```\n\n## How to Get Help\n\nThere are several ways to get help when working with SugarCRM development tools and APIs:\n\n- [Support Developer Guide](https://support.sugarcrm.com/documentation/sugar_developer/)  \n    Refer to the Support Developer Guide for detailed technical documentation and troubleshooting tips.\n    \n- [Engage with the Community](https://sugarclub.sugarcrm.com/dev-club/)  \n    Join the SugarCRM community to get support from experienced developers and users. The community is often the fastest way to get practical, real-world [answers](https://sugarclub.sugarcrm.com/dev-club/f/questions-answers).\n    \n- [Onboarding Framework](https://sugarclub.sugarcrm.com/dev-club/w/dev-tutorials/709/on-boarding-framework)  \n    Our onboarding framework is a comprehensive resource that consolidates best practices, expert guidance, and how-to articles from Sugar experts—all in one place.\n    \n- **Email Support**  \n    If you're stuck and need direct help, you can email us at [developers@sugarcrm.com](https://mailto:developers@sugarcrm.com). However, we recommend posting your question in the community first—our users often provide valuable insights quickly.\n    \n\n> **Tip:** When contacting us, please include:  \n\\- A detailed description of what you're trying to accomplish  \n\\- Any relevant code snippets  \n\\- Request and response objects (if applicable) \n  \n\nThis information helps us understand your issue faster and provide accurate support.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"16759889","team":1034843,"collectionId":"fd0e0781-31e2-4ebd-b0b5-e332448efc6f","publishedId":"2sB3BGJVq9","public":true,"publicUrl":"https://rest.apidocs.sugarcrm.com","privateUrl":"https://go.postman.co/documentation/16759889-fd0e0781-31e2-4ebd-b0b5-e332448efc6f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"SugarCRM RESTful API – Official Collection\nThis is the official RESTful API collection for Sugar Sell, Sugar Serve, and Sugar Enterprise.\n\nFor comprehensive API documentation, visit: https://apidocs.sugarcrm.com/"},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/2e787534-2a72-4a2a-a533-77e3f9fe574a/c3VnYXJjcm0tbG9nby1zdGFja2VkLXdodC5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/a9ca49f5-b45c-4dc5-83d0-b704c1896899/c3VnYXJjcm0tbG9nby1zdGFja2VkLWJsay5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-08-14T15:41:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"SugarCRM RESTful API – Official Collection\nThis is the official RESTful API collection for Sugar Sell, Sugar Serve, and Sugar Enterprise.\n\nFor comprehensive API documentation, visit: https://apidocs.sugarcrm.com/"},"logos":{"logoLight":"https://content.pstmn.io/a9ca49f5-b45c-4dc5-83d0-b704c1896899/c3VnYXJjcm0tbG9nby1zdGFja2VkLWJsay5wbmc=","logoDark":"https://content.pstmn.io/2e787534-2a72-4a2a-a533-77e3f9fe574a/c3VnYXJjcm0tbG9nby1zdGFja2VkLXdodC5wbmc="}},"statusCode":200},"environments":[{"name":"Syspro-Dev","id":"63b08356-0cfb-4235-8bc5-6fac3fcd275f","owner":"16759889","values":[{"key":"url","value":"http://docker.local/sugar","enabled":true,"type":"text"},{"key":"username","value":"admin","enabled":true,"type":"text"},{"key":"password","value":"sugarcrm","enabled":true,"type":"text"},{"key":"rest_version","value":"v11_21","enabled":true,"type":"default"},{"key":"rest_endpoint","value":"/rest/{{rest_version}}","enabled":true,"type":"text"},{"key":"access_token","value":"","enabled":true,"type":"any"},{"key":"refresh_token","value":"","enabled":true,"type":"any"}],"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/12cb1075be7c22fc47030052f4ae79c7d95f9286eead86c5a903c7b6ac648efc","favicon":"https://postman-image-service.postman.com/api/cloudinary-proxy/postman/image/upload/v1776433026/team/1e4cbe57bb1bafd90f5439947004a1f3"},"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":"Syspro-Dev","value":"16759889-63b08356-0cfb-4235-8bc5-6fac3fcd275f"}],"canonicalUrl":"https://rest.apidocs.sugarcrm.com/view/metadata/2sB3BGJVq9"}