SugarCRM

Sugar REST API

The Sugar REST API is hosted on each Sugar deployment at https:///rest/v{version}/ (v10 through v11_20). 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.

GitHub

Documentation

📖
Documentation
https://support.sugarcrm.com/documentation/sugar_developer/
📖
APIReference
https://support.sugarcrm.com/documentation/sugar_developer/sugar_developer_guide_13.0/integration/web_services/rest_api/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sugarcrm/refs/heads/main/authentication/sugarcrm-authentication.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
🔗
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_20). 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.
humanURL: https://support.sugarcrm.com/documentation/sugar_developer/sugar_developer_guide_13.0/integration/web_services/rest_api/
properties:
- type: Documentation
  url: https://support.sugarcrm.com/documentation/sugar_developer/
- type: APIReference
  url: https://support.sugarcrm.com/documentation/sugar_developer/sugar_developer_guide_13.0/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