SugarCRM

SugarCRM API

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

GitHub OpenAPI

Operations 91

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. #
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. #
GET /Emails/filter/count Lists filtered records. #
POST /Emails/filter/count Lists filtered records. #
GET /EmbeddedFiles/{record}/file/{field} Retrieves an attached file for a specific field on a record. #
POST /EmbeddedFiles/{record}/file/{field} Attaches a file to a field on a record. #
PUT /Employees Lists filtered records. #
POST /Filters Lists filtered records. #
GET /ForecastManagerWorksheets Returns a collection of ForecastManagerWorksheet models #
GET /ForecastManagerWorksheets/{timeperiodId} Returns a collection of ForecastManagerWorksheet models #
GET /ForecastManagerWorksheets/{timeperiodId}/{userId} Returns a collection of ForecastManagerWorksheet models #
POST /ForecastManagerWorksheets/assignQuota Assign Quotas to All Reporting Users for a given timeperiod #
POST /ForecastWorksheets Returns a collection of ForecastWorksheet models #
GET /ForecastWorksheets/{record} Returns a collection of ForecastWorksheet models #
PUT /ForecastWorksheets/{timeperiodId} Saves a collection of ForecastWorksheet models #
GET /ForecastWorksheets/{timeperiodId}/{userId} Returns a collection of ForecastWorksheet models #
POST /Forecasts Updates a record of a specified type as a favorite for the current user. #
GET /Forecasts/{timeperiodId}/{userId}/chart/{displayManager} Retrieve a Forecasting Information In SugarChart Format #
GET /Forecasts/{timeperiodId}/progressManager/{userId} Projected Manager Data #
GET /Forecasts/{timeperiodId}/progressRep/{userId} This endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel. #
GET /Forecasts/{timeperiodId}/quotas/direct/{userId} ForecastsQuotasApi - Get #
GET /Forecasts/{timeperiodId}/quotas/rollup/{userId} ForecastsQuotasApi - Get #
GET /Forecasts/config GET /Forecasts/config #
POST /Forecasts/config POST /Forecasts/config #
PUT /Forecasts/enum/selectedTimePeriod ForecastsApi Timeperiod filter info #
GET /Forecasts/init GET /Forecasts/init #
GET /Forecasts/reportees/{userId} ForecastsApi Reportees #
GET /Forecasts/user/{userId} This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id. #
GET /Genericsearch GET /Genericsearch #
POST /KBContents Lists filtered records. #
GET /Leads/{id}/freebusy Get a lead's FreeBusy schedule #
POST /rest/v10/{module}/record_list Create record list. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sugarcrm-com/openapi/_ae-authored/sugarcrm-com-openapi-generated.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sugarcrm-com:sugarcrm-com-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sugarcrm-com-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: SugarCRM API
  version: '2026-10-29'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-29: 91 operation(s) read from 11 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; SugarCRM has published no machine-readable contract
    that the pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 0
    documentation: 91
    pages-with-code: 0
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-29'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/dashboards_get
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/dashboards_post
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/emailsrecord_get
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/dashboardsmodule_get
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/dashboardsmodule_post
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/contactrecordcases_get
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/modulerecord_list_post
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/leadsrecordfreebusy_get
  - https://support.sugarai.com/documentation/sugar_developer/sugar_developer_guide_14.0/integration/web_services/rest_api/endpoints/dashboardsactivities_get


# --- truncated at 32 KB (53 KB total) ---
# Full source: https://artifacts.apis.io/sugarcrm-com/openapi/_ae-authored/sugarcrm-com-openapi-generated.yml