Blog Details
Blog Post Actions
Related
Recommended

Official Sugar REST API Postman Collection Is Live!

Rafael Fernandes
2 minute read time

We’re excited to announce that the official Sugar REST API Collection is now live and publicly available on Postman! 
You can explore it here: https://rest.apidocs.sugarcrm.com/

What’s Inside

This collection is designed to help developers explore, test, and integrate with the Sugar Sell, Sugar Serve, and Sugar Enterprise platforms more efficiently than ever before.

Organized for Real-World Use

We’ve structured the collection around practical needs:

  • Authorization – Everything you need to authenticate and manage tokens.

  • Modules CRUD – Core create, read, update, and delete operations that work across modules.

  • Use Cases – Real-world scenarios like Performance, Advanced Filtering, Upserts, SugarBPM, enum/dropdown handling and more.

Whether you're building a new integration, debugging a sync issue, or optimizing performance, the collection helps you hit the ground running.

Why It Matters

  • No need to copy-paste CURL commands or build your own tools from scratch.

  • Leverage multiple programing language examples through Postman languages

  • Faster prototyping and testing with a ready-to-use API playground.

  • Clear examples based on real-world use cases.

  • Organized by relevance—no hunting through massive lists of endpoints.

Help Us Improve

We built this collection for you, and we want your input to make it even better.

  • Missing an endpoint or use case?
  • Have a custom workflow or internal collection to share?
  • Documentation isn't clear enough or missing?

Send us your feedback, use cases, or even your own Postman collections, we’ll review and, if appropriate, add them to the official version (with credit, if you’d like!).

You can:

  • Drop your feedback in the Developer Community

  • Or email me directly at developers@sugarcrm.com

Let’s build the best possible API experience together.

Enjoy and happy coding.

Parents

  • Thanks for this - I couldn't find what i am searching for - I am calling reports into n8n, via /rest/v11_16/Reports/{REPORTID}/json
    But what I really need to be able to do, is affect run time filters - from n8n by sending query params in the url or the body...

    Has anyone found a way to do this? (use case is a monthly report from Sugar into Hubspot that delivers all the customers who have cars with anniversaries this month - across the last 4 years. There's no way I am aware of to make that an automated criteria inside of Sugar Reports - but I could make it a formula in n8n if I could send those across in the api...

  • in reply to Adam Ososki

    hi  ,

    correct you cannot update runtime filters in reports at this time, but based on your scenario, why do you need a report not going straight to our FilterApi (which is the same as our Reports API uses)? any issues there?

  • in reply to Rafael Fernandes

    I'm on the n8n integration side - so the data guys write the reports and give me the id's and I just pull them into n8n, clean up the formatting (removing £ and mapping names) so I can bulk import into hubspot - there will be a lot of different reports like this  - some daily, some weekly and some monthly. How would we use this FilterAPI - is it stand alone without a report - and we effectively write the report formula with instead?

Comment
  • in reply to Rafael Fernandes

    I'm on the n8n integration side - so the data guys write the reports and give me the id's and I just pull them into n8n, clean up the formatting (removing £ and mapping names) so I can bulk import into hubspot - there will be a lot of different reports like this  - some daily, some weekly and some monthly. How would we use this FilterAPI - is it stand alone without a report - and we effectively write the report formula with instead?

Children