# SugarCRM API

**Canonical:** https://apis.io/apis/sugarcrm-com/sugarcrm-com-api/  
**Provider:** SugarCRM — https://apis.io/providers/sugarcrm-com/  
**Documentation:** https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints

SugarCRM API is one of 2 APIs that [SugarCRM](https://apis.io/providers/sugarcrm-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

SugarCRM API as documented publicly: 91 operations. Contract generated from the documentation by API Evangelist (2026-10-29); not the provider's own document.

## Operations (60 of 91)

| Method | Path | Summary |
|---|---|---|
| GET | `/Accounts/{record}/link/{linkName}/filter` | Lists related filtered records. |
| GET | `/Activities` | Activities on the home page |
| GET | `/Activities/filter` | Activities on the home page |
| GET | `/Administration/aws` | [ADMIN] Gets Amazon Web Services configs from Sugar Serve. |
| GET | `/Administration/config/{category}` | [ADMIN] Get Configuration Settings for a Category. |
| POST | `/Administration/config/{category}` | [ADMIN] Set Configuration Settings for a Category. |
| POST | `/Administration/elasticsearch/indices` | [ADMIN] Elasticsearch index statistics |
| GET | `/Administration/elasticsearch/mapping` | [ADMIN] Elasticsearch mapping |
| GET | `/Administration/elasticsearch/queue` | [ADMIN] Elasticsearch queue statistics |
| POST | `/Administration/elasticsearch/refresh/enable` | [ADMIN] Elasticsearch enable refresh_interval |
| GET | `/Administration/elasticsearch/refresh/status` | [ADMIN] Elasticsearch index refresh interval status |
| POST | `/Administration/elasticsearch/refresh/trigger` | [ADMIN] Elasticsearch trigger explicit index refresh on all indices |
| POST | `/Administration/elasticsearch/replicas/enable` | [ADMIN] Elasticsearch enable replicas |
| GET | `/Administration/elasticsearch/replicas/status` | [ADMIN] Elasticsearch index replica status |
| GET | `/Administration/elasticsearch/routing` | [ADMIN] Elasticsearch index routing |
| POST | `/Administration/idm/migration/disable` | [ADMIN] Disable Idm migrations |
| POST | `/Administration/idm/migration/enable` | [ADMIN] Enable Idm migrations |
| GET | `/Administration/idm/users` | Lists filtered user records. |
| GET | `/Administration/license/limits` | [ADMIN] Get License Limits. |
| GET | `/Administration/packages` | [ADMIN] PackageManager list packages. |
| GET | `/Administration/packages/{fileInstall}/install` | GET /Administration/packages/{fileInstall}/install |
| GET | `/Administration/packages/{id}/disable` | GET /Administration/packages/{id}/disable |
| GET | `/Administration/packages/{id}/enable` | GET /Administration/packages/{id}/enable |
| GET | `/Administration/packages/{id}/uninstall` | GET /Administration/packages/{id}/uninstall |
| GET | `/Administration/packages/{unfile}` | GET /Administration/packages/{unfile} |
| DELETE | `/Administration/packages/installed` | [ADMIN] PackageManager lists installed packages. |
| GET | `/Administration/portalmodules` | GET /Administration/portalmodules |
| GET | `/Administration/search/fields` | [ADMIN] Search field configuration |
| GET | `/Administration/search/reindex` | [ADMIN] Search schedule reindex |
| POST | `/Administration/search/status` | [ADMIN] Search status |
| GET | `/Administration/settings/auth` | [ADMIN] Fetch auth settings. |
| DELETE | `/Administration/settings/idmMode` | [ADMIN] Turn IDM-mode off. |
| GET | `/Administration/settings/idmMode` | [ADMIN] Turn IDM-mode off. |
| POST | `/Calendar/invitee_search` | Temporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead. |
| GET | `/Calls` | Create a single event or a series of event records. |
| POST | `/Calls` | Create a single event or a series of event records. |
| DELETE | `/Calls/{record}` | Deletes either a single event record or a series of event records |
| PUT | `/Calls/{record}` | Update a calendar event record of the specified type. |
| PUT | `/Cases/clients/portal` | [ADMIN] Set a case as 'Requested For Close' |
| GET | `/CommentLog/{record}` | Returns a single parent record of the given commentlog. |
| POST | `/ConsoleConfiguration/config` | Saves configuration changes in the database. |
| GET | `/ConsoleConfiguration/default-metadata` | Gets the request metadata in JSON format. |
| GET | `/Contacts/{record}/freebusy` | Get a contact's FreeBusy schedule |
| GET | `/Currencies` | Returns a collection of Currency models |
| GET | `/Dashboards` | List current user's filtered Home dashboards. |
| POST | `/Dashboards` | Create a new Home dashboard. |
| PUT | `/Dashboards/{id}/restore-metadata` | PUT /Dashboards/{id}/restore-metadata |
| POST | `/Dashboards/Activities` | List current user's filtered Activity Stream dashboards. |
| POST | `/DataArchiver/{id}/run` | [ADMIN] Performs the archiving process. |
| POST | `/Documents/{record}/file/{field}` | Attaches a file to a field on a record. |
| PUT | `/EmailAddresses` | Update an existing email address. |
| POST | `/EmailAddresses/{record}` | Create a new email address. |
| GET | `/Emails` | Lists filtered emails. |
| PUT | `/Emails` | Update an existing Emails record. |
| GET | `/Emails/{record}` | Retrieves an Emails record. |
| POST | `/Emails/{record}` | Create a new Emails record. |
| PUT | `/Emails/{record}/link` | Creates a relationship to a pre-existing email. |
| DELETE | `/Emails/{record}/link/{linkName}/{remoteId}` | Deletes an existing relationship between an email and another record. |
| POST | `/Emails/{record}/link/{linkName}/{remoteId}` | Creates a relationship to a pre-existing email. |
| POST | `/Emails/{record}/link/{linkName}/add_record_list/{remoteId}` | Creates relationships to a pre-existing email from a record list. |

…and 31 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/sugarcrm-com/openapi/_ae-authored/sugarcrm-com-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-post-rest-v10-module-record-list-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-post-rest-v10-module-record-list-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-get-leads-id-freebusy-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-get-forecastmanagerworksheets-timeperiodid-userid-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-get-forecasts-timeperiodid-userid-chart-displaymanager-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/sugarcrm-com/json-schema/sugarcrm-com-get-forecastworksheets-record-response-schema.json

## Other SugarCRM APIs (1)

- [SugarCRM REST API](https://apis.io/apis/sugarcrm-com/sugarcrm-rest-api/)

---

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