Endpoints
The following sections contain the in-app help documentation for the REST endpoints.
Topics
Lists filtered records.
Create a new record of a specified type.
Removes a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.
Creates a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.
Delete a record of a specified type.
Retrieves a record.
Update a record of the specified type.
Returns data changes for a specific record.
Retrieves all children of selected record.
Lists related records from multiple links at a time.
Counts related records from multiple links at a time.
Removes a record of a specified type as a favorite for the current user.
Updates a record of a specified type as a favorite for the current user.
Lists all populated fields of type "file" or of type "image" for a record.
Removes an attachment from a field for a record and subsequently removes the file from the file system.
Retrieves an attached file for a specific field on a record.
Attaches a file to a field on a record.
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
Creates relationships to a pre-existing record.
Lists related filtered records.
Creates a related record.
Deletes an existing relationship between two records.
Retrieves a related record with relationship role information.
Creates a relationship to a pre-existing record.
Updates relationship specific information on an existing relationship.
Creates relationships to pre-existing record from a record list.
Lists related filtered records.
Lists related filtered records.
Lists related filtered records.
Lists related filtered records.
Lists related filtered records.
Activities on a module's list view
Activities on a module's list view
Lists history filtered records.
Returns related activity records for a specified record.
Move existing node after target node.
Move existing node before target node.
Move existing node as first child of target node.
Move existing node as last child of target node.
Retrieves next sibling of selected record.
Retrieves parent node for selected record.
Retrieves all parents of selected record.
Returns personally identifiable information (pii) fields with current data and source of data capture for a specific record.
Retrieves previous sibling of selected record.
This endpoint creates a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be subscribed to activity stream messages for the record being subscribed to, or "followed".
Removes a record of a specified type as a favorite for the current user.
This endpoint deletes a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be unsubscribe from activity stream messages for the record being subscribed to, or "followed".
Downloads a vCard.
Retrieves full tree for selected root record.
Activities on a module's list view
Activities on a module's list view
Append new node to target node as last child.
Returns a list of data changes for a specific module.
Retrieves the config settings for a given module.
Retrieves the config settings for a given module.
Retrieves the config settings for a given module.
Lists filtered records.
Create a new custom field for a specified module.
Delete a custom field for a specified module.
Runs a duplicate check against specified data.
Retrieves the enum values for a specific field.
Returns a record set in CSV format along with HTTP headers to indicate content type.
Opportunity Favorites Help
Opportunity Favorites Help
Imports a person record from a vcard.
Lists filtered records.
Lists filtered records.
Lists filtered records.
Lists filtered records.
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
Insert new node after target node.
Insert new node before target node.
An API to mass delete records.
An API to mass update records.
Append new node to target node as first child.
Opportunity Recent Product Help
Opportunity Recent Product Help
An API to create and save lists of records.
An API to delete lists of records
An API to return record list data
Deletes the record with the given sync_key.
Retrieves the record with the given sync_key.
Upserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it.
Upserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method.
Saves an image to a temporary folder.
Reads a temporary image and deletes it.
Lists related filtered records.
Activities on the home page
Activities on the home page
[ADMIN] Gets Amazon Web Services configs from Sugar Serve.
[ADMIN] Set Amazon Web Services configs in Sugar Serve.
[ADMIN] Get Configuration Settings for a Category.
[ADMIN] Set Configuration Settings for a Category.
[ADMIN] Elasticsearch index statistics
[ADMIN] Elasticsearch mapping
[ADMIN] Elasticsearch queue statistics
[ADMIN] Elasticsearch enable refresh_interval
[ADMIN] Elasticsearch index refresh interval status
[ADMIN] Elasticsearch trigger explicit index refresh on all indices
[ADMIN] Elasticsearch enable replicas
[ADMIN] Elasticsearch index replica status
[ADMIN] Elasticsearch index routing
[ADMIN] Disable Idm migrations
[ADMIN] Enable Idm migrations
Lists filtered user records.
[ADMIN] Get License Limits.
[ADMIN] PackageManager list packages.
[ADMIN] PackageManager upload package.
[ADMIN] PackageManager install a package.
[ADMIN] PackageManager disable a package.
[ADMIN] PackageManager enable a package.
[ADMIN] PackageManager uninstall a package.
[ADMIN] PackageManager delete a package.
[ADMIN] PackageManager lists installed packages.
[ADMIN] PackageManager lists staged packages.
[ADMIN] Gets an array of modules currently enabled for Sugar Portal.
[ADMIN] Search field configuration
[ADMIN] Search schedule reindex
[ADMIN] Search status
[ADMIN] Fetch auth settings.
[ADMIN] Turn IDM-mode off.
[ADMIN] Turn IDM-mode on.
Run API calls in bulk.
Temporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead.
Create a single event or a series of event records.
Deletes either a single event record or a series of event records
Update a calendar event record of the specified type.
[ADMIN] Set a case as 'Requested For Close'
Lists records from multiple modules at a time.
Retrieves a record.
Responds with twitter timeline if connector is set up in administration
Responds with twitter timeline if connector is set up in administration
Gets general info about connectors.
Saves configuration changes in the database.
Gets the request metadata in JSON format.
Get a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility.
Get a contact's FreeBusy schedule
Runs LessPHP for a platform and a theme and outputs an array of css files. If not found the css files
Runs LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because
Returns a collection of Currency models
List current user's filtered Home dashboards.
Create a new Home dashboard.
Restores the metadata for a module's dashboard to the default metadata.
List current user's filtered dashboards.
Create a new dashboard.
List current user's filtered Activity Stream dashboards.
[ADMIN] Performs the archiving process.
Attaches a file to a field on a record.
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
Create a new email address.
Update an existing email address.
Lists filtered emails.
Create a new Emails record.
Retrieves an Emails record.
Update an existing Emails record.
Creates a relationship to a pre-existing email.
Deletes an existing relationship between an email and another record.
Creates a relationship to a pre-existing email.
Creates relationships to a pre-existing email from a record list.
Lists filtered emails.
Lists filtered emails.
Lists filtered records.
Lists filtered records.
Lists filtered records.
Retrieves an attached file for a specific field on a record.
Attaches a file to a field on a record.
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
Lists filtered records.
Retrieve a Forecasting Information In SugarChart Format
Retrieve a Forecasting Information In SugarChart Format
Lists filtered records.
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Assign Quotas to All Reporting Users for a given timeperiod
Returns a record set in CSV format along with HTTP headers to indicate content type.
Returns a collection of ForecastManagerWorksheet models
Returns a collection of ForecastManagerWorksheet models
Updates a record of a specified type as a favorite for the current user.
Retrieve a Forecasting Information In SugarChart Format
Projected Manager Data
This endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel.
ForecastsQuotasApi - Get
ForecastsQuotasApi - Get
Creates and/or updates the config settings for the Forecasts module
Creates and/or updates the config settings for the Forecasts module
ForecastsApi Timeperiod filter info
This endpoint is used to return initialization data for the Forecasts module.
ForecastsApi Reportees
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.
Returns a collection of ForecastWorksheet models
Saves a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
Returns a record set in CSV format along with HTTP headers to indicate content type.
Returns a collection of ForecastWorksheet models
Returns a collection of ForecastWorksheet models
This endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic".
This endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic".
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
Fetches the help documentation
Fetches the documentation on which exceptions are thrown by the API, their
Removes a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.
Creates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.
Sets a sync key value for a record.
Sets a sync key value for a record. Note that the PATCH method is recommended over the PUT method.
Deletes the record with the given sync_key_field_name.
Retrieves the record with the given sync_key_field_name.
Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.
Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method.
Lists filtered records.
Creates relationships to a pre-existing record.
Vote for Knowledge Base article.
Vote for Knowledge Base article.
Creates and/or updates the config settings for the KBContents module
Creates and/or updates the config settings for the KBContents module
Runs a duplicate check against specified data.
Lists filtered records.
Update display labels of dropdown items for dropdowns under different languages.
Update display labels of fields for modules under different languages.
Create Lead with optional post-save actions
Convert Lead to a Contact and optionally link it to a new or existing instance of the modules specified
Get a lead's FreeBusy schedule
Creates new Leads.
Logs a message to the Sugar Log
Returns information to facilitate receiving marketing content from SugarCRM.
Returns the SugarCRM marketing content URL that is managed by the marketing team.
Create an email and send or save as draft.
Validate one or more email addresses.
Archives an email.
Upload an email attachment
Delete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)
Clears the user's attachment cache directory
Finds recipients that match the search term.
Accepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive
Returns the current user object.
Returns the current user object.
Returns all of the current users followed records
Create a new record of a specified type.
Create a new record of a specified type.
Deletes a specific preference for the current user.
Returns a specific preference for the current user.
Creates a preference for the current user.
Updates a specific preference for the current user.
Returns all the current user's stored preferences.
Mass updates preferences for the user.
Create a single event or a series of event records.
Deletes either a single event record or a series of event records
Update a calendar event record of the specified type.
Retrieves info about launching an external meeting
[ADMIN] Gets the desired segment for a given module.
Fetches the most active users for meetings, calls, inbound emails, and outbound emails.
Lists filtered records.
ATTENTION: FOR INTERNAL USAGE ONLY
Expires the token portion of the OAuth 2.0 specification.
Get an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition.
Retrieves the token portion of the OAuth 2.0 specification.
Update a record of the specified type.
Opportunity Config Save
Retrieves the enum values for a specific field.
Create a new OutboundEmail configuration to use to send emails over SMTP.
Update an OutboundEmail configuration.
Lists the current user's outbound email configurations for sending email.
Sends an email request to reset a users password.
Lists filtered records.
PdfManager Generate Endpoint Help
Responds with "pong" if the access_token is valid.
Responds with the current time in server format.
Lists filtered records.
Exports a .pbr file with a Process Business Rules definition
Imports a Process Business Rules definition from a .pbr file
Lists filtered records.
Get the related module list for a module
Exports a .pet file with a Process Email Templates definition
Imports a Process Email Templates definition from a .pet file
Get the variable list for a module
Returns a list of Processes by user using filters
Returns the process status image file
Deprecated endpoint.
Deprecated endpoint.
Call methods to cancel a process
Retrieve information of the process record
Returns a list with the processes for Process Management
Deprecated endpoint.
Clear the PMSE.log file log
Deletes a process note
Claims the processes to the current user
Evaluates the response of the user form Show Process [Approve, Reject, Route]
Returns a list of Processes by user
Return the text of the PMSE.log file
Gets the history log for a process
Returns the notes list for a process
Deprecated endpoint.
Call methods to reassign processes
Retrieve information to reassign processes
Deprecated endpoint.
Deprecated endpoint.
Creates a new note for a process
Retrieve settings for the PA engine
Update settings for the SugarBPMTM engine
Retrieves the processes to show on Unattended Process view
Deprecated endpoint.
Lists filtered records.
Exports a .bpm file with a Process Definition
Verifies whether the Process Definition has any pending processes
Retrieves the definition data for an activity
Updates the definition data for an activity
Retrieves information about Fields, Modules, Users, Roles, etc.
Updates information about Fields, Modules, Users, Roles, etc.
Retrieves the definition data for an event
Updates the definition data for an event
Imports a Process Definition from a .bpm file
Retrieves the definition data for a gateway
Updates the definition data for a gateway
Retrieves the schema data to be used by the Process Definition designer
Updates the schema data from the Process Definition designer
Validates information about Fields, Modules, Users, Roles, etc.
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
Quote Convert to Opportunity
Quote Config GET Help
Quote Config POST Help
Returns all of the current users recently viewed records.
An API to run a saved report and export the result.
An API to get chart data for a saved report.
An API to get total number of filtered records from a saved report.
An API to deliver filtered records from a saved report.
Convert a Revenue Line Item to a quote.
Convert Multiple Revenue Line Item to a quote.
Consumes an RSS feed as a proxy and returns the feed up to a certain number of entries.
List records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.
Update a record of the specified type.
Creates relationships to a pre-existing record.
Deletes an existing relationship between two records.
Creates a relationship to a pre-existing record.
Fetches the customizable variables of a theme.
Updates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments.
Lists filtered records.
Return a Timeperiod by a given date
Get the get the current timeperiod
Lists filtered records.
Lists filtered records.
Delete a User and return its ID
Get a user's FreeBusy schedule
Creates relationships to a pre-existing record.
Deletes an existing relationship between two records.
Creates a relationship to a pre-existing record.
Downloads a vCard.