# Sugar REST API

**Canonical:** https://apis.io/apis/sugarcrm/sugar-rest-api/  
**Provider:** SugarCRM — https://apis.io/providers/sugarcrm/  
**Base URL:** https://{instance}.sugarondemand.com/rest/v11_27/  
**Documentation:** https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_26.1/integration/web_services/rest_api/

Sugar REST API is published by [SugarCRM](https://apis.io/providers/sugarcrm/) on the [APIs.io](https://apis.io/) network. The published artifact set on APIs.io includes API documentation, an API reference, authentication docs, and rate-limit docs.

The Sugar REST API is hosted on each Sugar deployment at https://<site_url>/rest/v{version}/ (v10 through v11.27). SugarCloud instances are hosted on Sugar's own sugarondemand.com domain, so a cloud tenant's base is https://{instance}.sugarondemand.com/rest/v11_27/; on-site deployments substitute the customer's own site URL. It authenticates with two-legged OAuth 2.0 (password + refresh_token grants, OAuth-Token header), returns JSON with ISO 8601 dates, uses offset pagination, and exposes CRM modules through /{module} and /{module}/filter routes. Each instance serves its own endpoint reference at /rest/v{version}/help; no public OpenAPI is published.

## Machine-readable artifacts (9)

- **Documentation** — https://support.sugarai.com/documentation/sugar_developer/
- **APIReference** — https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_26.1/integration/web_services/rest_api/
- **Authentication** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/authentication/sugarcrm-authentication.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/conventions/sugarcrm-conventions.yml
- **ErrorCatalog** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/errors/sugarcrm-problem-types.yml
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/rate-limits/sugarcrm-rate-limits.yml
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/asyncapi/sugarcrm-webhooks.yml
- **Sandbox** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/sandbox/sugarcrm-sandbox.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/sugarcrm/sugar-rest-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/sugarcrm/.