SugarCRM

Sugar REST API

The Sugar REST API is hosted on each Sugar deployment at https:///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.

GitHub

Documentation

📖
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
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/rate-limits/sugarcrm-rate-limits.yml

Other Resources

🔗
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
🔗
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

API entry from apis.yml

apis.yml Raw ↑ 
name: Sugar REST API
description: 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.
humanURL: https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_26.1/integration/web_services/rest_api/
baseURL: https://{instance}.sugarondemand.com/rest/v11_27/
properties:
- type: Documentation
  url: https://support.sugarai.com/documentation/sugar_developer/
- type: APIReference
  url: https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_26.1/integration/web_services/rest_api/
- type: Authentication
  url: authentication/sugarcrm-authentication.yml
- type: Conventions
  url: conventions/sugarcrm-conventions.yml
- type: ErrorCatalog
  url: errors/sugarcrm-problem-types.yml
- type: RateLimits
  url: rate-limits/sugarcrm-rate-limits.yml
- type: Webhooks
  url: asyncapi/sugarcrm-webhooks.yml
- type: Sandbox
  url: sandbox/sugarcrm-sandbox.yml