id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
26cf9eac6623-3 | */
class cstmSugarApiExceptionError extends SugarApiException
{
public $httpCode = 404;
public $errorLabel = 'my_error';
public $messageLabel = 'EXCEPTION_CSTM_LABEL_KEY';
}
Create a custom language label using the extension framework:
./custom/Extension/application/Ext/Language/<name>.php
<?php
$app_strings['EXCEPTION_CSTM_LABEL_KEY'] = 'My Exception Message.';
You can call your new exception by using the following code :Â
require_once 'custom/include/api/<name>.php';
//throwing custom api exception using the default message
throw new cstmSugarApiExceptionError();
//throwing custom api exception using a custom language label key
throw new cstmSugarApiExceptionError('EXCEPTION_CSTM_LABEL_KEY');
//throwing custom api exception with text
throw new cstmSugarApiExceptionError('There has been an error.');
You will then need to navigate to Admin > Repair > Quick Repair and Rebuild before using your exception.
The exception error will return a response of:Â
{
"error": "my_error",
"error_message": "There has been an error."
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html |
356359101acc-0 | Extending Endpoints
Overview
How to add your own custom endpoints to the REST API.
Custom Endpoints
With the REST architecture, you can easily define your own endpoint. All custom global endpoints will be located in ./custom/clients/<client>/api/. All custom endpoints specific to a module will be located in ./custom/modules/<module>/clients/<client>/api/.
Note: The Sugar application client type is "base". More information on the various client types can be found in the Clients section.
Defining New Endpoints
The endpoint class will be created in ./custom/clients/<client>/api/ and will extend SugarApi. Within this class, you will need to implement a registerApiRest() function that will define your endpoint paths. When creating a new endpoint, please note that the file name must match the class name for the endpoint definitions. The example below demonstrates creating a GET endpoint.
./custom/clients/base/api/MyEndpointsApi.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
class MyEndpointsApi extends SugarApi
{
public function registerApiRest()
{
return array(
//GET
'MyGetEndpoint' => array(
//request type
'reqType' => 'GET',
//set authentication
'noLoginRequired' => false,
//endpoint path
'path' => array('MyEndpoint', 'GetExample', '?'),
//endpoint variables
'pathVars' => array('', '', 'data'),
//method to call
'method' => 'MyGetMethod',
//short help string to be displayed in the help documentation
'shortHelp' => 'An example of a GET endpoint',
//long help to be displayed in the help documentation | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-1 | //long help to be displayed in the help documentation
'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',
),
);
}
/**
* Method to be used for my MyEndpoint/GetExample endpoint
*/
public function MyGetMethod($api, $args)
{
//custom logic
return $args;
}
}
?>
Note: The file name must match the class name for the endpoint definitions. Given the example above, a class name of MyEndpointsApi must be created as MyEndpointsApi.php.
registerApiRest() Method
Your extended class will contain two methods. The first method is registerApiRest() which will return an array that defines your REST endpoints. Each endpoint will need the following properties:
Name
Type
Description
reqType
Array | String
An array of one or many request types of the endpoint. Possible values are: GET, PUT, POST and DELETE.
noLoginRequired
Boolean
Determines whether the endpoint is authenticated. Setting this value to true will remove the authentication requirement.
path
Array
The endpoint path. An endpoint path of:
'path' => array('MyEndpoint', 'GetExample'),
Will equate to the URL path of http://{site url}/rest/{REST VERSION}/MyEndpoint/GetExample.
To pass in a variable string to your endpoint, you will add a path of '?'. This will allow you to pass URL data to your selected method given that it is specified in the pathVars.
pathVars
Array
The path variables. For each path on your endpoint, you can opt to pass its value in as a parameter to your selected method. An empty path variable will ignore the path.
Example: | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-2 | Example:
'path' => array('MyEndpoint', 'GetExample', '?'),
'pathVars' => array('', '', 'data'),
The above will pass information to your selected method as the $args parameter when calling http://{site url}/rest/{REST VERSION}/MyEndpoint/GetExample/MyData
method
String
The method to pass the pathVars to. This can be named anything you choose and will be located in your SugarApi extended class.
shortHelp
String
A short help string for developers when looking at the help documentation.
longHelp
String
Path to a long help file. This file will be loaded when a user clicks an endpoint from the help documentation.
minVersion
Integer
The minimum API Version this endpoint can be used with. See Scoring Section below.Â
maxVersion
IntegerÂ
The maximum API Version this endpoint can be used with. See Scoring Section below.Â
extraScore
IntegerÂ
Add an extra score value to the Scoring of this endpoint, to place priority on its usage. See Scoring Section below.
Endpoint Method
The second method can be named anything you choose but it is important to note that it will need to match the name of the method you specified for your endpoint. This method will require the parameters $api and $args. The MyGetMethod() in the example above will be used when the endpoint MyEndpoint/GetExample is called. Any path variables, query string parameters or posted data will be available in the $args parameter for you to work with.
public function MyEndpointMethod($api, $args)
{
//logic
return $returnData;
}
Help Documentation | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-3 | {
//logic
return $returnData;
}
Help Documentation
The final step once you have your endpoint working is to document it. This file can reside anywhere in the system and will be referenced in your endpoints longHelp property. An example of the help documentation can be found below:
custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html
<h2>Overview</h2>
<span class="lead">
A custom GET endpoint. Returns the $args parameter that is passed to the endpoint method.
</span>
<h2>Path Variables</h2>
<table class="table table-hover">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
:data
</td>
<td>
Data string to pass to the endpoint.
</td>
</tr>
</tbody>
</table>
<h2>Input Parameters</h2>
<span class="lead">
This endpoint does not accept any input parameters.
</span>
<h2>Result</h2>
<table class="table table-hover">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
__sugar_url
</td>
<td>
String
</td>
<td>
The endpoint path.
</td>
</tr>
<tr>
<td>
data
</td> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-4 | <tr>
<td>
data
</td>
<td>
String
</td>
<td>
The data from path variable.
</td>
</tr>
</tbody>
</table>
<h3>Output Example</h3>
<pre class="pre-scrollable">
{
"__sugar_url":"v10\/MyEndpoint\/GetExample\/MyData",
"data":"MyData"
}
</pre>
<h2>Change Log</h2>
<table class="table table-hover">
<thead>
<tr>
<th>Version</th>
<th>Change</th>
</tr>
</thead>
<tbody>
<tr>
<td>
v10
</td>
<td>
Added <code>/MyEndpoint/GetExample/:data</code> GET endpoint.
</td>
</tr>
</tbody>
</table>
Quick Repair and Rebuild
Once all of the files are in place, you will need to navigate to Admin > Repair > Quick Repair and Rebuild. This will rebuild the ./cache/file_map.php and ./cache/include/api/ServiceDictionary.rest.php files to make your endpoint available.
Example
./custom/clients/base/api/MyEndpointsApi.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
class MyEndpointsApi extends SugarApi
{
public function registerApiRest()
{
return array(
//GET & POST
'MyGetEndpoint' => array(
//request type
'reqType' => array('GET','POST'), | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-5 | //request type
'reqType' => array('GET','POST'),
//set authentication
'noLoginRequired' => false,
//endpoint path
'path' => array('MyEndpoint', 'GetExample', '?'),
//endpoint variables
'pathVars' => array('', '', 'data'),
//method to call
'method' => 'MyGetMethod',
//short help string to be displayed in the help documentation
'shortHelp' => 'An example of a GET endpoint',
//long help to be displayed in the help documentation
'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',
),
);
}
/**
* Method to be used for my MyEndpoint/GetExample endpoint
*/
public function MyGetMethod($api, $args)
{
//custom logic
return $args;
}
}
?>
Redefining Existing Endpoints
With endpoints, you may have a need to extend an existing endpoint to meet your needs. When doing this it is important that you do not remove anything from the return array of the endpoint. Doing so could result in unexpected behavior due to other functionality using the same endpoint.
For this example, we will extend the ping endpoint to return "Pong <timestamp>". To do this, we will need to extend the existing PingApi class and define our method overrides. When creating a new endpoint, please note that the file name must match the class name for the endpoint definitions. For our example, we will prefix the original class name with "custom" to create our overriding endpoint.
./custom/clients/base/api/CustomPingApi.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point'); | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-6 | require_once("clients/base/api/PingApi.php");
class CustomPingApi extends PingApi
{
public function registerApiRest()
{
//in case we want to add additional endpoints
return parent::registerApiRest();
}
//override to modify the ping function of the ping endpoint
public function ping($api, $args)
{
$result = parent::ping($api, $args);
//append the current timestamp
return $result . ' ' . time();
}
}
Note: The file name must match the class name for the endpoint definitions. Given the example above, a class name of CustomPingApi must be created as CustomPingApi.php.
As you can see, we extended registerApiRest to fetch existing endpoint definitions in case we want to add our own. We then added an override for the ping method to return our new value. Once the file is in place you will need to navigate to Admin > Repair > Quick Repair and Rebuild. Once completed, any call made to <url>/rest/{REST VERSION}/ping will result in a response of "ping <timestamp>".
Endpoint Scoring
When generating custom endpoints or overriding existing endpoints, the system can determine which endpoint to use based on the score placed on the registered endpoints. The scoring calculation works in the following manner for registered endpoints.
Route Path
Score
?
0.75
<module>
1.0
Exact Match
1.75
Custom
0.5
Endpoint 'extraScore' property
Defined Extra Score
 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-7 | Custom
0.5
Endpoint 'extraScore' property
Defined Extra Score
Â
The defined Path and extraScore properties in the registerApiRest() method, help determine the score for any given Endpoint. The higher the score allows the API to determine which Endpoint is being used for a given request. For example, if you had extended the /Accounts/:record GET API Endpoint as follows:Â
/custom/modules/Accounts/clients/base/api/CustomAccountsApi.php
<?php
if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
require_once("clients/base/api/ModuleApi.php");
class CustomAccountsApi extends ModuleApi
{
public function registerApiRest()
{
return array(
//GET & POST
'getAccount' => array(
//request type
'reqType' => array('GET'),
//set authentication
'noLoginRequired' => false,
//endpoint path
'path' => array('Accounts', '?'),
//endpoint variables
'pathVars' => array('module', 'record'),
//method to call
'method' => 'retrieveRecord',
//short help string to be displayed in the help documentation
'shortHelp' => 'An example of a GET endpoint',
//long help to be displayed in the help documentation
'longHelp' => 'custom/clients/base/api/help/MyEndPoint_MyGetEndPoint_help.html',
),
);
}
/**
* Method to be used for my Accounts/:record endpoint
*/
public function retrieveRecord($api, $args)
{
//custom logic
return parent::retrieveRecord($api,$args);
}
}
?> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-8 | return parent::retrieveRecord($api,$args);
}
}
?>
 This Endpoint will be used when accessing /Accounts/<record_id> since the Exact Match of Accounts in the path property gives a greater score than the <module> match that comes with the standard /<module>/:record Endpoint defined in ModuleApi.
Endpoint Versioning
Part of the scoring calculation allows for versioning of the API Endpoints to accommodate the same endpoint path in the Rest API, for other versions of the API. If you have a custom Endpoint at /rest/v10/CustomEndpoint, and would like to alter the logic slightly for another use without deprecating or removing the old Endpoint, you can use the versioning techniques to have the new logic reside at /rest/v11/CustomEndpoint. The following table describes how the Versioning properties on the Endpoint definition affect the score of the Endpoint to allow the API to determine which Endpoint should be used for a given request.
 Property
ScoreÂ
 minVersion
0.02 + minVersion/1000Â
 maxVersion
0.02Â
 minVersion === maxVersion (i.e. Both minVersion and maxVersion properties are defined on Endpoint to the same value)
0.06 + minVersion/1000
Â
To allow for additional Versions in the API, you will first need to customize the 'maxVersion' property in the $apiSettings array. To do this, create ./custom/include/api/metadata.php. Inside the file you can set the $apiSettings['maxVersion'] property as follows:
<?php
$apiSettings['maxVersion'] = 11;
 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-9 | <?php
$apiSettings['maxVersion'] = 11;
Â
Once you have configured the Max Version property, you can then set the minVersion and maxVersion properties on the Endpoint definition in the custom registerApiRest() method. For example, the following Endpoint definitions:Â
<?php
...
return array(
'foo1' => array(
'reqType' => 'GET',
'path' => array('Accounts','config',
'pathVars' => array('module', 'record'),
'method' => 'foo1',
),
'foo2' => array(
'reqType' => 'GET',
'minVersion' => 11,
'path' => array('Accounts','config',
'pathVars' => array('module', 'record'),
'method' => 'foo2',
),
'foo3' => array(
'reqType' => 'GET',
'minVersion' => 11,
'maxVersion' => 11,
'path' => array('Accounts','config',
'pathVars' => array('module', 'record'),
'method' => 'foo3',
),
'foo4' => array(
'reqType' => 'GET',
'minVersion' => 11,
'maxVersion' => 12,
'path' => array('Accounts','config',
'pathVars' => array('module', 'record'),
'method' => 'foo3',
),
'foo5' => array(
'reqType' => 'GET',
'minVersion' => 14,
'path' => array('Accounts','config', | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
356359101acc-10 | 'path' => array('Accounts','config',
'pathVars' => array('module', 'record'),
'method' => 'foo5',
),
);
...
With the above definitions, the following table provides the Expected Request for each Endpoint.
 Request URI
Best RouteÂ
 /rest/v10/Accounts/config
foo1
 /rest/v11/Accounts/config
foo3
 /rest/v12/Accounts/config
foo4Â
 /rest/v13/Accounts/config
foo2Â
 /rest/v14/Accounts/config
foo5Â
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Extending_Endpoints/index.html |
612910f18ca5-0 | Endpoints
The following sections contain the in-app help documentation for the REST endpoints. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-1 | Topics/Accounts/:record/link/:link_name/filter GETLists related filtered records./Activities GETActivities on the home page/Activities/filter GETActivities on the home page/Administration/aws GET[ADMIN] Gets Amazon Web Services configs from Sugar Serve./Administration/aws POST[ADMIN] Set Amazon Web Services configs in Sugar Serve./Administration/config/:category GET[ADMIN] Get Configuration Settings for a Category./Administration/config/:category POST[ADMIN] Set Configuration Settings for a Category./Administration/elasticsearch/indices GET[ADMIN] Elasticsearch index statistics/Administration/elasticsearch/mapping GET[ADMIN] Elasticsearch mapping/Administration/elasticsearch/queue GET[ADMIN] Elasticsearch queue statistics/Administration/elasticsearch/refresh/enable POST[ADMIN] Elasticsearch enable refresh_interval/Administration/elasticsearch/refresh/status GET[ADMIN] Elasticsearch index refresh interval status/Administration/elasticsearch/refresh/trigger POST[ADMIN] Elasticsearch trigger explicit index refresh on all indices/Administration/elasticsearch/replicas/enable POST[ADMIN] Elasticsearch enable replicas/Administration/elasticsearch/replicas/status GET[ADMIN] Elasticsearch index replica status/Administration/elasticsearch/routing GET[ADMIN] Elasticsearch index routing/Administration/idm/migration/disable POST[ADMIN] Disable Idm migrations/Administration/idm/migration/enable POST[ADMIN] Enable Idm migrations/Administration/idm/users GETLists filtered user records./Administration/license/limits GET[ADMIN] Get License Limits./Administration/packages GET[ADMIN] PackageManager list packages./Administration/packages POST[ADMIN] PackageManager upload package./Administration/packages/:file_install/install GET[ADMIN] PackageManager install a package./Administration/packages/:id/disable GET[ADMIN] PackageManager disable a package./Administration/packages/:id/enable GET[ADMIN] PackageManager enable a package./Administration/packages/:id/uninstall GET[ADMIN] PackageManager uninstall a package./Administration/packages/installed GET[ADMIN] PackageManager lists installed packages./Administration/packages/staged GET[ADMIN] PackageManager lists staged packages./Administration/packages/:unFile DELETE[ADMIN] PackageManager delete a | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-2 | PackageManager lists staged packages./Administration/packages/:unFile DELETE[ADMIN] PackageManager delete a package./Administration/portalmodules GET[ADMIN] Gets an array of modules currently enabled for Sugar Portal./Administration/search/fields GET[ADMIN] Search field configuration/Administration/search/reindex POST[ADMIN] Search schedule reindex/Administration/search/status GET[ADMIN] Search status/Administration/settings/auth GET[ADMIN] Fetch auth settings./Administration/settings/idmMode DELETE[ADMIN] Turn IDM-mode off./Administration/settings/idmMode POST[ADMIN] Turn IDM-mode on./Calendar/invitee_search GETTemporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead./Calls POSTCreate a single event or a series of event records./Calls/:record DELETEDeletes either a single event record or a series of event records/Calls/:record PUTUpdate a calendar event record of the specified type./Cases/clients/portal PUT[ADMIN] Set a case as 'Requested For Close'/CommentLog/:record GETRetrieves a record./ConsoleConfiguration/config POSTSaves configuration changes in the database./ConsoleConfiguration/default-metadata GETGets the request metadata in JSON format./Contact/:record/Cases GETGet a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility./Contacts/:record/freebusy GETGet a contact's FreeBusy schedule/Currencies GETReturns a collection of Currency models/Dashboards/Activities GETList current user's filtered Activity Stream dashboards./Dashboards GETList current user's filtered Home dashboards./Dashboards POSTCreate a new Home dashboard./Dashboards/:id/restore-metadata PUTRestores the metadata for a module's dashboard to the default metadata./Dashboards/<module> GETList current user's filtered dashboards./Dashboards/<module> POSTCreate a new dashboard./DataArchiver/:id/run POST[ADMIN] Performs the archiving process./Documents/:record/file/:field POSTAttaches | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-3 | POST[ADMIN] Performs the archiving process./Documents/:record/file/:field POSTAttaches a file to a field on a record./Documents/:record/file/:field PUTThis 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/EmailAddresses POSTCreate a new email address./EmailAddresses/:record PUTUpdate an existing email address./Emails GETLists filtered emails./Emails POSTCreate a new Emails record./Emails/count GETLists filtered emails./Emails/filter GETLists filtered emails./Emails/filter POSTLists filtered records./Emails/filter/count GETLists filtered records./Emails/filter/count POSTLists filtered records./Emails/:record GETRetrieves an Emails record./Emails/:record PUTUpdate an existing Emails record./Emails/:record/link POSTCreates a relationship to a pre-existing email./Emails/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to a pre-existing email from a record list./Emails/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between an email and another record./Emails/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing email./EmbeddedFiles/:record/file/:field GETRetrieves an attached file for a specific field on a record./EmbeddedFiles/:record/file/:field POSTAttaches a file to a field on a record./EmbeddedFiles/:record/file/:field PUTThis 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-4 | 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/Employees GETLists filtered records./ExpressionEngine/:record/related GETRetrieve a Forecasting Information In SugarChart Format/ExpressionEngine/:record/related POSTRetrieve a Forecasting Information In SugarChart Format/Filters GETLists filtered records./ForecastManagerWorksheets GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/assignQuota POSTAssign Quotas to All Reporting Users for a given timeperiod/ForecastManagerWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastManagerWorksheets/filter GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/filter POSTReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastManagerWorksheet models/ForecastWorksheets GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastWorksheets/filter GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/filter POSTReturns a collection of ForecastWorksheet models/ForecastWorksheets/:record PUTSaves a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastWorksheet models/Forecasts GETUpdates a record of a specified type as a favorite for the current user./Forecasts/config POSTCreates and/or updates the config settings for the Forecasts module/Forecasts/config PUTCreates and/or updates the config settings for the Forecasts module/Forecasts/enum/selectedTimePeriod GETForecastsApi Timeperiod | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-5 | for the Forecasts module/Forecasts/enum/selectedTimePeriod GETForecastsApi Timeperiod filter info/Forecasts/init GETThis endpoint is used to return initialization data for the Forecasts module./Forecasts/reportees/:user_id GETForecastsApi Reportees/Forecasts/:timeperiod_id/progressManager/:user_id GETProjected Manager Data/Forecasts/:timeperiod_id/progressRep/:user_id GETThis endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel./Forecasts/:timeperiod_id/quotas/direct/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/quotas/rollup/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/:user_id/chart/:display_manager GETRetrieve a Forecasting Information In SugarChart Format/Forecasts/user/:user_id GETThis 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./Genericsearch GETThis 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"./Genericsearch POSTThis 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"./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETERemoves 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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-6 | fields, and those records are related, then remove the relationship of the RHS record to the LHS record./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POSTCreates 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./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCHSets a sync key value for a record./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUTSets a sync key value for a record. Note that the PATCH method is recommended over the PUT method./integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETEDeletes the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value GETRetrieves the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCHUpserts 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./integrate/<module>/:sync_key_field_name/:sync_key_field_value PUTUpserts 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./KBContents GETLists filtered records./KBContents/config POSTCreates and/or updates the config settings for the KBContents module/KBContents/config PUTCreates and/or updates the config settings for the KBContents module/KBContents/duplicateCheck POSTRuns a duplicate check against specified data./KBContents/filter GETLists | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-7 | POSTRuns a duplicate check against specified data./KBContents/filter GETLists filtered records./KBContents/:record/link POSTCreates relationships to a pre-existing record./KBContents/:record/notuseful PUTVote for Knowledge Base article./KBContents/:record/useful PUTVote for Knowledge Base article./Leads POSTCreate Lead with optional post-save actions/Leads/:leadId/convert POSTConvert Lead to a Contact and optionally link it to a new or existing instance of the modules specified/Leads/:record/freebusy GETGet a lead's FreeBusy schedule/Leads/register POSTCreates new Leads./Mail POSTCreate an email and send or save as draft./Mail/address/validate POSTValidate one or more email addresses./Mail/archive POSTArchives an email./Mail/attachment POSTUpload an email attachment/Mail/attachment/cache DELETEClears the user's attachment cache directory/Mail/attachment/:file_guid DELETEDelete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)/Mail/recipients/find GETFinds recipients that match the search term./Mail/recipients/lookup POSTAccepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive/Meetings POSTCreate a single event or a series of event records./Meetings/:record DELETEDeletes either a single event record or a series of event records/Meetings/:record PUTUpdate a calendar event record of the specified type./Meetings/:record/external GETRetrieves info about launching an external meeting/Notifications GETLists filtered records./Opportunities/config POSTOpportunity Config Save/Opportunities/enum/:field GETRetrieves the enum values for a specific field./Opportunities/:record PUTUpdate a record of the specified type./OutboundEmailConfiguration/list GETLists the current user's outbound email configurations for sending email./OutboundEmail POSTCreate a new OutboundEmail configuration to use to send emails over | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-8 | sending email./OutboundEmail POSTCreate a new OutboundEmail configuration to use to send emails over SMTP./OutboundEmail/:record PUTUpdate an OutboundEmail configuration./PdfManager GETLists filtered records./PdfManager/generate GETPdfManager Generate Endpoint Help/ProductTemplates/tree GETThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/ProductTemplates/tree POSTThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/Quotes/config GETQuote Config GET Help/Quotes/config POSTQuote Config POST Help/Quotes/:record/opportunity POSTQuote Convert to Opportunity/Reports/:record/chart GETAn API to get chart data for a saved report./Reports/:record/record_count GETAn API to get total number of filtered records from a saved report./Reports/:record/records GETAn API to deliver filtered records from a saved report./Reports/:record/:type GETAn API to run a saved report and export the result./RevenueLineItems/multi-quote POSTConvert Multiple Revenue Line Item to a quote./RevenueLineItems/:record/quote POSTConvert a Revenue Line Item to a quote./Tags/:record PUTUpdate a record of the specified type./Teams/:record/link POSTCreates relationships to a pre-existing record./Teams/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Teams/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./TimePeriods GETLists filtered records./TimePeriods/current GETGet the get the current timeperiod/TimePeriods/:date GETReturn a Timeperiod by a given date/TimePeriods/filter GETLists filtered records./Users GETLists filtered records./Users/:record DELETEDelete a User and return its ID/Users/:record/freebusy GETGet a user's FreeBusy schedule/Users/:record/link POSTCreates relationships to a pre-existing | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-9 | GETGet a user's FreeBusy schedule/Users/:record/link POSTCreates relationships to a pre-existing record./Users/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Users/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./VCardDownload GETDownloads a vCard./bulk POSTRun API calls in bulk./collection/:collection_name GETLists records from multiple modules at a time./connectors GETGets general info about connectors./connector/twitter/currentUser GETResponds with twitter timeline if connector is set up in administration/connector/twitter/:twitterId GETResponds with twitter timeline if connector is set up in administration/css GETRuns LessPHP for a platform and a theme and outputs an array of css files. If not found the css files/css/preview GETRuns LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/help GETFetches the help documentation/help/exceptions GETFetches the documentation on which exceptions are thrown by the API, their/lang/labels/dropdown PUTUpdate display labels of dropdown items for dropdowns under different languages./lang/labels/module PUTUpdate display labels of fields for modules under different languages./logger POSTLogs a message to the Sugar Log/login/content GETReturns information to facilitate receiving marketing content from SugarCRM./login/marketingContentUrl GETReturns the SugarCRM marketing content URL that is managed by the marketing team./me GETReturns the current user object./me PUTReturns the current user object./me/following GETReturns all of the current users followed records/me/password POSTCreate a new record of a specified type./me/password PUTCreate a new record of a specified type./me/preference/:preference_name | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-10 | PUTCreate a new record of a specified type./me/preference/:preference_name DELETEDeletes a specific preference for the current user./me/preference/:preference_name GETReturns a specific preference for the current user./me/preference/:preference_name POSTCreates a preference for the current user./me/preference/:preference_name PUTUpdates a specific preference for the current user./me/preferences GETReturns all the current user's stored preferences./me/preferences PUTMass updates preferences for the user./metadata/<module>/:segment GET[ADMIN] Gets the desired segment for a given module./<module>/Activities GETActivities on a module's list view/<module>/Activities/filter GETActivities on a module's list view/<module>/MassUpdate DELETEAn API to mass delete records./<module>/MassUpdate PUTAn API to mass update records./<module> GETLists filtered records./<module> POSTCreate a new record of a specified type./<module>/append/:target POSTAppend new node to target node as last child./<module>/audit/export GETReturns a list of data changes for a specific module./<module>/config GETRetrieves the config settings for a given module./<module>/config POSTRetrieves the config settings for a given module./<module>/config PUTRetrieves the config settings for a given module./<module>/count GETLists filtered records./<module>/customfield POSTCreate a new custom field for a specified module./<module>/customfield/:field DELETEDelete a custom field for a specified module./<module>/duplicateCheck POSTRuns a duplicate check against specified data./<module>/enum/:field GETRetrieves the enum values for a specific field./<module>/export/:record_list_id GETReturns a record set in CSV format along with HTTP headers to indicate content type./<module>/favorites GETOpportunity Favorites Help/<module>/favorites POSTOpportunity Favorites Help/<module>/file/vcard_import | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-11 | Favorites Help/<module>/favorites POSTOpportunity Favorites Help/<module>/file/vcard_import POSTImports a person record from a vcard./<module>/filter GETLists filtered records./<module>/filter POSTLists filtered records./<module>/filter/count GETLists filtered records./<module>/filter/count POSTLists filtered records./<module>/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/insertafter/:target POSTInsert new node after target node./<module>/insertbefore/:target POSTInsert new node before target node./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETERemoves 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./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POSTCreates 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./<module>/prepend/:target POSTAppend new node to target node as first child./<module>/recent-product GETOpportunity Recent Product Help/<module>/recent-product POSTOpportunity Recent Product Help/<module>/:record DELETEDelete a record of a specified type./<module>/:record GETRetrieves a record./<module>/:record PUTUpdate a record of the specified type./<module>/record_list POSTAn API to create and save lists of records./<module>/record_list/:record_list_id DELETEAn API to delete lists of records/<module>/record_list/:record_list_id GETAn API to return | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-12 | API to delete lists of records/<module>/record_list/:record_list_id GETAn API to return record list data/<module>/:record/audit GETReturns data changes for a specific record./<module>/:record/children GETRetrieves all children of selected record./<module>/:record/collection/:collection_name GETLists related records from multiple links at a time./<module>/:record/collection/:collection_name/count GETCounts related records from multiple links at a time./<module>/:record/favorite DELETERemoves a record of a specified type as a favorite for the current user./<module>/:record/favorite PUTUpdates a record of a specified type as a favorite for the current user./<module>/:record/file GETLists all populated fields of type "file" or of type "image" for a record./<module>/:record/file/:field DELETERemoves an attachment from a field for a record and subsequently removes the file from the file system./<module>/:record/file/:field GETRetrieves an attached file for a specific field on a record./<module>/:record/file/:field POSTAttaches a file to a field on a record./<module>/:record/file/:field PUTThis 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/<module>/:record/link POSTCreates relationships to a pre-existing record./<module>/:record/link/activities GETActivities on a module's list view/<module>/:record/link/activities/filter GETActivities on a module's list view/<module>/:record/link/history GETLists history filtered | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-13 | GETActivities on a module's list view/<module>/:record/link/history GETLists history filtered records./<module>/:record/link/:link_name GETLists related filtered records./<module>/:record/link/:link_name POSTCreates a related record./<module>/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to pre-existing record from a record list./<module>/:record/link/:link_name/count GETLists related filtered records./<module>/:record/link/:link_name/filter GETLists related filtered records./<module>/:record/link/:link_name/filter/count GETLists related filtered records./<module>/:record/link/:link_name/filter/leancount GETLists related filtered records./<module>/:record/link/:link_name/leancount GETLists related filtered records./<module>/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./<module>/:record/link/:link_name/:remote_id GETRetrieves a related record with relationship role information./<module>/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./<module>/:record/link/:link_name/:remote_id PUTUpdates relationship specific information on an existing relationship./<module>/:record/link/related_activities GETReturns related activity records for a specified record./<module>/:record/moveafter/:target PUTMove existing node after target node./<module>/:record/movebefore/:target PUTMove existing node before target node./<module>/:record/movefirst/:target PUTMove existing node as first child of target node./<module>/:record/movelast/:target PUTMove existing node as last child of target node./<module>/:record/next GETRetrieves next sibling of selected record./<module>/:record/parent GETRetrieves parent node for selected record./<module>/:record/path GETRetrieves all parents | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-14 | parent node for selected record./<module>/:record/path GETRetrieves all parents of selected record./<module>/:record/pii GETReturns personally identifiable information (pii) fields with current data and source of data capture for a specific record./<module>/:record/prev GETRetrieves previous sibling of selected record./<module>/:record/subscribe POSTThis 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"./<module>/:record/unfavorite PUTRemoves a record of a specified type as a favorite for the current user./<module>/:record/unsubscribe DELETEThis 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"./<module>/:record/vcard GETDownloads a vCard./<module>/:root/tree GETRetrieves full tree for selected root record./<module>/sync_key/:sync_key_field_value DELETEDeletes the record with the given sync_key./<module>/sync_key/:sync_key_field_value GETRetrieves the record with the given sync_key./<module>/sync_key/:sync_key_field_value PATCHUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it./<module>/sync_key/:sync_key_field_value PUTUpserts 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./<module>/temp/file/:field POSTSaves an image to a temporary folder./<module>/temp/file/:field/:temp_id GETReads a temporary image and deletes | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-15 | folder./<module>/temp/file/:field/:temp_id GETReads a temporary image and deletes it./mostactiveusers GETFetches the most active users for meetings, calls, inbound emails, and outbound emails./oauth2/bwc/login POSTATTENTION: FOR INTERNAL USAGE ONLY/oauth2/logout POSTExpires the token portion of the OAuth 2.0 specification./oauth2/sudo/:user_name POSTGet 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./oauth2/token POSTRetrieves the token portion of the OAuth 2.0 specification./password/request GETSends an email request to reset a users password./ping GETResponds with "pong" if the access_token is valid./ping/whattimeisit GETResponds with the current time in server format./pmse_Business_Rules GETLists filtered records./pmse_Business_Rules/file/businessrules_import POSTImports a Process Business Rules definition from a .pbr file/pmse_Business_Rules/:record/brules GETExports a .pbr file with a Process Business Rules definition/pmse_Emails_Templates GETLists filtered records./pmse_Emails_Templates/file/emailtemplates_import POSTImports a Process Email Templates definition from a .pet file/pmse_Emails_Templates/:/find_modules GETGet the related module list for a module/pmse_Emails_Templates/:record/etemplate GETExports a .pet file with a Process Email Templates definition/pmse_Emails_Templates/variables/find GETGet the variable list for a module/pmse_Inbox/AdhocReassign PUTDeprecated endpoint./pmse_Inbox/AdhocReassign/:data/:flowId GETDeprecated | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-16 | PUTDeprecated endpoint./pmse_Inbox/AdhocReassign/:data/:flowId GETDeprecated endpoint./pmse_Inbox/ReassignForm PUTDeprecated endpoint./pmse_Inbox/ReassignForm/:data/:flowId GETDeprecated endpoint./pmse_Inbox GETReturns a list of Processes by user using filters/pmse_Inbox/cancelCases PUTCall methods to cancel a process/pmse_Inbox/case/:id/:idflow GETRetrieve information of the process record/pmse_Inbox/casesList GETReturns a list with the processes for Process Management/pmse_Inbox/changeCaseUser/:cas_id GETDeprecated endpoint./pmse_Inbox/clearLog/:typelog PUTClear the PMSE.log file log/pmse_Inbox/delete_notes/:id DELETEDeletes a process note/pmse_Inbox/engine_claim PUTClaims the processes to the current user/pmse_Inbox/engine_route PUTEvaluates the response of the user form Show Process [Approve, Reject, Route]/pmse_Inbox/filter GETReturns a list of Processes by user/pmse_Inbox/getLog GETReturn the text of the PMSE.log file/pmse_Inbox/historyLog/:filter GETGets the history log for a process/pmse_Inbox/note_list/:cas_id GETReturns the notes list for a process/pmse_Inbox/reactivateFlows PUTDeprecated endpoint./pmse_Inbox/reassignFlows PUTCall methods to reassign processes/pmse_Inbox/reassignFlows/:record GETRetrieve information to reassign processes/pmse_Inbox/:record/file/:field GETReturns the process status image file/pmse_Inbox/save_notes POSTCreates a new note for a process/pmse_Inbox/settings GETRetrieve settings for the PA engine/pmse_Inbox/settings PUTUpdate settings for the SugarBPMTM engine/pmse_Inbox/unattendedCases GETRetrieves the processes to show on Unattended Process view/pmse_Inbox/userListByTeam/:id GETDeprecated | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-17 | processes to show on Unattended Process view/pmse_Inbox/userListByTeam/:id GETDeprecated endpoint./pmse_Project/ActivityDefinition/:record GETRetrieves the definition data for an activity/pmse_Project/ActivityDefinition/:record PUTUpdates the definition data for an activity/pmse_Project/CrmData/:data/:filter GETRetrieves information about Fields, Modules, Users, Roles, etc./pmse_Project/CrmData/:record/:filter PUTUpdates information about Fields, Modules, Users, Roles, etc./pmse_Project/EventDefinition/:record GETRetrieves the definition data for an event/pmse_Project/EventDefinition/:record PUTUpdates the definition data for an event/pmse_Project/GatewayDefinition/:record GETRetrieves the definition data for a gateway/pmse_Project/GatewayDefinition/:record PUTUpdates the definition data for a gateway/pmse_Project GETLists filtered records./pmse_Project/file/project_import POSTImports a Process Definition from a .bpm file/pmse_Project/project/:record GETRetrieves the schema data to be used by the Process Definition designer/pmse_Project/project/:record PUTUpdates the schema data from the Process Definition designer/pmse_Project/:record/dproject GETExports a .bpm file with a Process Definition/pmse_Project/:record/verify GETVerifies whether the Process Definition has any pending processes/pmse_Project/validateCrmData/:data/:filter GETValidates information about Fields, Modules, Users, Roles, etc./recent GETReturns all of the current users recently viewed records./rssfeed GETConsumes an RSS feed as a proxy and returns the feed up to a certain number of entries./search GETList 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./theme GETFetches the customizable variables of a theme./theme POSTUpdates the variables.less (less file containing customizable | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-18 | the customizable variables of a theme./theme POSTUpdates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
612910f18ca5-19 | Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html |
18c96c145523-0 | /ForecastWorksheets GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Query Parameters:
Param
Description
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
18c96c145523-1 | "date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheets_GET/index.html |
b7fb1c0da32a-0 | /pmse_Project/file/project_import POST
Overview
Imports a Process Definition from a .bpm file
Summary
This endpoint will import a Process Definition from the uploaded .bpm file
containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
selectedIds
array
A list of IDs for dependent elements to import.
False
Request
Note: A JSON encoded .bpm file attachment should be included with
the request as part of the form-data. An optional array of IDs can be included to indicate
which dependent Business Rules and Email Templates to import and link with the Process Definition.
The file must contain the metadata for the dependent elements as well for the selectedIds to be used.
Important: The request format must be multipart/form-data.
Response Arguments
Name
Type
Description
project_import
Object
Result of the import operation
Response
{
"project_import":
{
"success":true,
"id":"459f05de-3c3a-c0e7-ce1e-573cabe79e7c",
"br_warning":true,
"et_warning":true
}
}
Compatibility
SugarBPMTM files exported from Sugar version 7.6.1.0 or earlier cannot be imported to Sugar instances running 7.6.2.0 or later.
Change Log
Version
Change
v11_2
Added support for selectedIds to specify which dependent elements to import.
v10
Added /pmse_Project/file/project_import POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectfileproject_import_POST/index.html |
f28c535027f0-0 | /<module>/config PUT
Overview
Retrieves the config settings for a given module.
Summary
This endpoint is normally used to manage the forecasting module.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
Added /<module>/config PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_PUT/index.html |
2d1bce1bfc24-0 | /<module>/insertbefore/:target POST
Overview
Insert new node before target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to insert new node before
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",
"name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html |
2d1bce1bfc24-1 | "_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/insertbefore/:target POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html |
4d2807c9548f-0 | /Activities/filter GET
Activities on the home page
Summary:
This endpoint lists activities across the entire sytstem. It uses a subscription model, and can be queried like a normal bean collection, but without search, ordering or filtering.
Query Parameters:
ParamDescriptionOptionalmax_numA maximum number of records to returnOptionaloffsetHow many records to skip over before records are returnedOptional
Input Example:
This endpoint does not accept any input
Output Example:
{
"next_offset": 20, This will be set to -1 when there are no more records after this "page".
"records": [{
"id": "22fb8b16-de1d-f1dc-b15b-51240efde177",
"date_entered": "2013-02-19T23:47:11+00:00",
"date_modified": "2013-02-19T23:47:11+00:00",
"created_by": "1",
"deleted": "0",
"parent_id": "f5bb0331-2c0f-5c7c-b4db-5123caac0056",
"parent_type": "Contacts",
"activity_type": "post", This will be the type of activity performed.
"data": {
"value": "This is a test post on a contact I'm subscribed to."
},
"comment_count": 0, This will be set to the total number of comments on the post.
"last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0,
"data": []
},
"fields": [],
"first_name": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html |
4d2807c9548f-1 | },
"fields": [],
"first_name": null,
"last_name": "Administrator",
"created_by_name": " Administrator" This will be the locale-formatted full name of the user.
}, ... ]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Activitiesfilter_GET/index.html |
f68af5ca38ab-0 | /<module>/MassUpdate PUT
Overview
An API to mass update records.
Query String Parameters
Name
Type
Description
Required
massupdate_params
Array
Mass update parameters.
True
massupdate_params.uid
Array
A list of ids.
True
massupdate_params.[field name]
[field type]
The field to be modified.
False
massupdate_params.team_name
Array
Team array.
False
massupdate_params.team_name_type
String
Whether to replace or add teams. Possible values are 'add' and 'replace'.
False
Request
Mass Updating Records by ID in a Module
{
"massupdate_params":{
"uid":[
"f22d1955-97d8-387d-9866-512d09cc1520",
"ef1b40aa-5815-4f8d-e909-512d09617ac8"
],
"department":"Marketing"
}
}
Mass Updating Records with Teams
{
"massupdate_params":{
"uid":[
"f22d1955-97d8-387d-9866-512d09cc1520",
"ef1b40aa-5815-4f8d-e909-512d09617ac8"
],
"team_name":[
{
"id":"35eab226-c20d-48f4-4670-512d095c8c6f",
"primary":true
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html |
f68af5ca38ab-1 | "primary":true
},
{
"id":"8f640aba-f356-7374-7eb4-512d09745551",
"primary":false
}
],
"team_name_type":"replace"
}
}
Mass Add Leads, Contacts or Prospects to a Target List
{
"massupdate_params": {
"uid": [ /* Leads, Contacts, or Prospects to Add */
"f3d90a49-14b4-a81c-6cac-526e6c71d33e",
"f22cde0d-9a20-89d3-ca14-526e6c3c4d08",
"f15f10bd-1445-5e20-9b5c-526e6ceb71d0"
],
"prospect_lists": [
/* Prospect List(s) to Add them To */
"bc5bc249-9c9c-52ad-52b9-526e71f0e18d"
]
}
}
Response Arguments
Name
Type
Description
Status
String
The status of the mass update. Possible value is 'done'.
Output Done Example
{
"status":"done"
}
Change Log
Version
Change
v10
Added /<module>/MassUpdate PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html |
193181ce7356-0 | /KBContents GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
193181ce7356-1 | False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
193181ce7356-2 | False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
193181ce7356-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
193181ce7356-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
193181ce7356-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContents_GET/index.html |
4eaaa2cae4d7-0 | /mostactiveusers GET
Overview
Fetches the most active users for meetings, calls, inbound emails, and outbound emails.
Request Arguments
Name
Type
Description
Required
days
Integer
Returns most active users for the last specified quantity of days. Defaults to 30 days if not specified.
False
Request
http://{site_url}/rest/v10/mostactiveusers?days=30
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Response
{
"meetings":{
"user_id":"seed_sarah_id",
"count":"20",
"first_name":"Sarah",
"last_name":"Smith"
},
"calls":{
"user_id":"seed_will_id",
"count":"7",
"first_name":"Will",
"last_name":"Westin"
},
"inbound_emails":{
"user_id":"seed_sarah_id",
"count":"20",
"first_name":"Sarah",
"last_name":"Smith"
},
"outbound_emails":{
"user_id":"seed_max_id",
"count":"17",
"first_name":"Max",
"last_name":"Jensen"
}
}
Change Log
Version
Change
v10
Added /mostactiveusers GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mostactiveusers_GET/index.html |
3c72bd551969-0 | /pmse_Business_Rules GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3c72bd551969-1 | False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3c72bd551969-2 | False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3c72bd551969-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3c72bd551969-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3c72bd551969-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rules_GET/index.html |
3fa8e4c533c6-0 | /Opportunities/enum/:field GET
Overview
Retrieves the enum values for a specific field.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<list values>
Array
Returns the enum values for a field.
Response
{
"":"",
"Analyst":"Analyst",
"Competitor":"Competitor",
"Customer":"Customer",
"Integrator":"Integrator",
"Investor":"Investor",
"Partner":"Partner",
"Press":"Press",
"Prospect":"Prospect",
"Reseller":"Reseller",
"Other":"Other"
}
Change Log
Version
Change
v10
Added /<module>/enum/:field GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesenumfield_GET/index.html |
2a2f8f76c87f-0 | /TimePeriods/current GET
Get the get the current timeperiod
Summary:
This endpoint is used to get the current TimePeriod. If one is not found a 404 is returned
Output Example:
{
"id":"e394485a-5889-ea75-84c8-51543bd1a5ba",
"name":"Q1 (01\/01\/2013 - 03\/31\/2013)",
"parent_id":"e28efe2d-c51c-be45-3d84-51543b4d2910",
"start_date":"2013-01-01",
"start_date_timestamp":"1356998400",
"end_date":"2013-03-31",
"end_date_timestamp":"1364774399",
"created_by":"1",
"date_entered":"2013-03-28 12:46:36",
"date_modified":"2013-03-28 12:46:36",
"deleted":"0",
"is_fiscal":"0",
"is_fiscal_year":"0",
"leaf_cycle":"1",
"type":"Quarter",
"related_timeperiods":""
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodscurrent_GET/index.html |
00699a82d9b4-0 | /me GET
Overview
Returns the current user object.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Response User
{
"current_user":{
"type":"user",
"id":"1",
"full_name":"Administrator",
"timepref":"h:ia",
"timezone":"America/Los_Angles",
"user_name":"admin"
}
}
Response Portal User
{
"current_user":{
"type":"support_portal",
"id":"1234-567",
"user_id":"abcd-123",
"full_name":"Bill Williamson",
"timepref":"h:ia",
"timezone":"America/Denver",
"user_name":"SupportPortalApi"
}
}
Change Log
Version
Change
v10
Added /me GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_GET/index.html |
58629a6ccfc2-0 | /EmailAddresses POST
Overview
Create a new email address.
Summary
In the event that the email address already exists, that record will be returned without making any changes.
Request Arguments
Name
Type
Description
Required
email_address
String
The email address.
True
invalid_email
Boolean
true if the email address is invalid. false is the default.
False
opt_out
Boolean
true if the email address is opted out. false is the default.
False
Request
{
"email_address": "eharmon@example.com",
"invalid_email": false,
"opt_out": false
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_created": "2016-02-25T11:53:07-08:00",
"date_modified": "2016-02-25T11:53:07-08:00",
"deleted": false,
"email_address": "eharmon@example.com",
"email_address_caps": "EHARMON@EXAMPLE.COM",
"invalid_email": false,
"opt_out": false,
"_acl": {
"fields": {}
},
"_module": "EmailAddresses"
}
Change Log
Version
Change
v10
Added /EmailAddresses POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html |
58629a6ccfc2-1 | Change
v10
Added /EmailAddresses POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html |
824a2b077520-0 | /<module>/globalsearch POST
Overview
Global search
Summary
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
/search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request
arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your
client has no support for GET requests with a body, the POST method can be used as an alternative.
Request Arguments
Name
Type
Description
Required
q
String
The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The
results are ordered by relevance which is based on a multitude of settings based on token counts, hit
ratio, (weighted) boost values and type of field. Currently no operators are supported in the search
expression itself. By refining the search expression more relevant results will be returned as top results.
If no search expression is given results are returned based on last modified date.
False
module_list
String
Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that
when consuming the endpoint /:module/globalsearch that this parameter is ignored.
Example: Accounts,Contacts
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
highlights
Boolean
Wether or not to return highlighted results. Default is true. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_POST/index.html |
824a2b077520-1 | Wether or not to return highlighted results. Default is true.
False
sort
Array
Define the sort order of the results. By default the results are returned by relevance which is the
preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the
not sorting by relevance may have a negative performance impact.
Example: {"date_modified":"desc","name":"asc"}
False
Request
{
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
}
Change Log
Version
Change
v10
Added /globalsearch GET/POST endpoint.
v10
Added /:module/globalsearch GET/POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_POST/index.html |
1809ef4cfa9d-0 | /ForecastWorksheets/:record PUT
Saves a collection of ForecastWorksheet models
Summary:
This endpoint is used to save the json Data for an array of worksheet data array entries
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
{ "amount" : "10000.000000",
"assigned_user_id" : "seed_max_id",
"base_rate" : "1",
"best_case" : "25000",
"commit_stage" : "include",
"currency_id" : "-99",
"current_user" : "seed_max_id",
"date_closed" : "2013-01-14",
"date_modified" : "2013-01-14T10:58:27-05:00",
"draft" : 1,
"id" : "347beb60-d57c-b3aa-5922-50f42b6c27d4",
"likely_case" : "15000",
"name" : "RR. Talker Co - 1000 units",
"probability" : "90",
"product_id" : "34b0d547-adaf-03ea-146c-50f42b3e6f04",
"sales_stage" : "Value Proposition",
"timeperiod_id" : "36f7085a-5889-ea75-84c8-50f42bd1a5ba",
"version" : 1,
"w_date_modified" : "2013-01-14T10:58:27-05:00",
"worksheet_id" : "e0adb532-7d1c-eb49-b102-50f42b455164", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
1809ef4cfa9d-1 | "worst_case" : "10000.000000"
}
Output Example:
{ "amount" : "15000.000000",
"assigned_user_id" : "seed_max_id",
"base_rate" : "1",
"best_case" : "25000.000000",
"commit_stage" : "include",
"currency_id" : "-99",
"date_closed" : "2013-01-14",
"date_modified" : "2013-01-15T10:52:31-05:00",
"id" : "347beb60-d57c-b3aa-5922-50f42b6c27d4",
"likely_case" : "15000.000000",
"name" : "RR. Talker Co - 1000 units",
"probability" : "90",
"product_id" : "34b0d547-adaf-03ea-146c-50f42b3e6f04",
"sales_stage" : "Value Proposition",
"version" : 1,
"w_date_modified" : "2013-01-14T10:58:27-05:00",
"worksheet_id" : "e0adb532-7d1c-eb49-b102-50f42b455164",
"worst_case" : "10000.000000"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsrecord_PUT/index.html |
73c4617d7c87-0 | /<module>/:record/link POST
Overview
Creates relationships to a pre-existing record.
Request Arguments
Name
Type
Description
Required
<relationship link>
<string>
Link between targeted and related records.
True
<record ID>
<string>
The name value list of related records. Each item of the list may be either string equal to related item ID,
or map containing record ID ("id" key is required in this case)
and addition relationship properties.
True
Request
{
link_name: "accounts"
ids: [
"da6a3741-2a81-ba7f-f249-512d0932e94e",
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"role": "owner"
}
]
}
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Records that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-1 | "modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-2 | "worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"name": "Gus Dales",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_name": [
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"salutation": "",
"first_name": "Gus",
"last_name": "Dales",
"full_name": "Gus Dales",
"title": "Director Operations",
"linkedin": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"department": "",
"do_not_call": false,
"phone_home": "(661) 120-2292",
"email": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-3 | "email": [
{
"email_address": "section.sugar.section@example.it",
"opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "support.qa.kid@example.co.uk",
"opt_out": "0",
"invalid_email": "0",
"primary_address": "1"
}
],
"phone_mobile": "(294) 447-9707",
"phone_work": "(036) 840-3216",
"phone_other": "",
"phone_fax": "",
"email1": "support.qa.kid@example.co.uk",
"email2": "section.sugar.section@example.it",
"invalid_email": false,
"email_opt_out": false,
"primary_address_street": "48920 San Carlos Ave",
"primary_address_street_2": "",
"primary_address_street_3": "",
"primary_address_city": "Persistance",
"primary_address_state": "CA",
"primary_address_postalcode": "54556",
"primary_address_country": "USA",
"alt_address_street": "",
"alt_address_street_2": "",
"alt_address_street_3": "",
"alt_address_city": "",
"alt_address_state": "",
"alt_address_postalcode": "",
"alt_address_country": "",
"assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "Support Portal User Registration",
"account_name": "Arts & Crafts Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-4 | "account_name": "Arts & Crafts Inc",
"account_id": "d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields": "",
"opportunity_role_id": "",
"opportunity_role": "Technical Advisor",
"reports_to_id": "",
"report_to_name": "",
"portal_name": "GusDales145",
"portal_active": true,
"portal_password": "$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1": "",
"portal_app": "",
"preferred_language": "en_us",
"campaign_id": "",
"campaign_name": "",
"c_accept_status_fields": "",
"m_accept_status_fields": "",
"accept_status_id": "",
"accept_status_name": "",
"sync_contact": "",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
{
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-5 | "created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:36:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
73c4617d7c87-6 | "_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10 (7.6.0)
Added support for additional relationship values.
v10 (7.1.5)
Added /<module>/:record/link POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlink_POST/index.html |
e6d81236ce7c-0 | /OutboundEmailConfiguration/list GET
Overview
Lists the current user's outbound email configurations for sending email.
Summary
Used by the Emails module for selecting an outbound email configuration for sending an email.
Response
[
{
"id": "ecbf2a6c-261e-5fca-fbb6-512d093554b8",
"name": "George Lee ",
"type": "user",
"default": false
},
{
"id": "af5f8dae-7169-b497-1d77-512d0937ed81",
"name": "ACME, Inc. ",
"type": "system",
"default": true
}
]
Change Log
Version
Change
v11
Last version in which /OutboundEmailConfiguration/list GET is available. Use
/Emails/enum/outbound_email_id GET instead.
v10
Added the /OutboundEmailConfiguration/list GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailConfigurationlist_GET/index.html |
dccbef7fff8f-0 | /globalsearch GET
Overview
Global search
Summary
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
/search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request
arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your
client has no support for GET requests with a body, the POST method can be used as an alternative.
Request Arguments
Name
Type
Description
Required
q
String
The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The
results are ordered by relevance which is based on a multitude of settings based on token counts, hit
ratio, (weighted) boost values and type of field. Currently no operators are supported in the search
expression itself. By refining the search expression more relevant results will be returned as top results.
If no search expression is given results are returned based on last modified date.
False
module_list
String
Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that
when consuming the endpoint /:module/globalsearch that this parameter is ignored.
Example: Accounts,Contacts
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
highlights
Boolean
Wether or not to return highlighted results. Default is true. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html |
dccbef7fff8f-1 | Wether or not to return highlighted results. Default is true.
False
sort
Array
Define the sort order of the results. By default the results are returned by relevance which is the
preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the
not sorting by relevance may have a negative performance impact.
Example: {"date_modified":"desc","name":"asc"}
False
Request
{
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
}
Change Log
Version
Change
v10
Added /globalsearch GET/POST endpoint.
v10
Added /:module/globalsearch GET/POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/globalsearch_GET/index.html |
2d845cf6c74e-0 | /Reports/:record/chart GET
Overview
An API to get chart data for a saved report.
Summary
This endpoint will return chart data for a saved report.
Request Arguments
None.
Request Example
GET /rest/v10/Reports/:id/chart
Response Arguments
Name
Type
Description
reportData
Array
Report def for the chart.
chartData
Array
The chart data for a report.
Response
{
"reportData":
{
"label":"Accounts by Industry",
"id":"a06b4212-3509-11e7-ab6e-f45c898a3ce7",
...
},
"chartData":
{
"properties":[...],
"values":[...],
...
}
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordchart_GET/index.html |
d183601eb408-0 | /<module>/:record/favorite PUT
Overview
Updates a record of a specified type as a favorite for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
d183601eb408-1 | "linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019",
"shipping_address_country":"USA",
"email1":"kid.support.vegan@example.info",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"kid.support.vegan@example.info",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"phone.kid@example.cn", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
d183601eb408-2 | },
{
"email_address":"phone.kid@example.cn",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":true,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
7e26f3e6a76f-0 | /Genericsearch GET
Overview
Generic search.
Summary
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".
Request Arguments
Name
Type
Description
Required
q
String
The search expression.
True
module_list
String
Comma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
total
Integer
The number of records found.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"total": 1,
"records": [
{
"name": "Connecting to the Internet",
"description": "To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.",
"url": "portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for portal)
"url": "#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for base)
}
]
}
Change Log
Version
Change
v11_9
Added /Genericsearch GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html |
7e26f3e6a76f-1 | Version
Change
v11_9
Added /Genericsearch GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_GET/index.html |
8a9846991e78-0 | /pmse_Inbox/reassignFlows/:record GET
Overview
Retrieve information to reassign processes
Summary
This endpoint gets information necessary to reassign a process
Request Arguments
Name
Type
Description
Required
record
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
success
boolean
Result of the routing operation
next_offset
integer
Next offset for more results
records
<field>:<value>
List of process attributes
Response
{
"success":true,
"next_offset":-1,
"records":
[
{
"cas_id":"2",
"cas_index":"3",
"cas_task_start_date":null,
"cas_delegate_date":"2016-06-01T16:18:59-07:00",
"cas_flow_status":"FORM",
"cas_user_id":"seed_sarah_id",
"cas_due_date":"",
"cas_sugar_module":"Accounts",
"bpmn_id":"7c62acc2-2842-11e6-9b9c-6c4008960436",
"act_name":"Activity # 1",
"act_assignment_method":"static",
"act_expected_time":"eyJ0aW1lIjpudWxsLCJ1bml0IjoiaG91ciJ9",
"cas_expected_time":"",
"assigned_user":"Sarah Smith"
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxreassignFlowsrecord_GET/index.html |
4238c8026138-0 | /pmse_Project/project/:record GET
Overview
Retrieves the schema data to be used by the Process Definition designer
Summary
This endpoint will retrieve the JSON encoded schema data for the Process
Definition identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
project
Object
The schema data for the Process Definition
Response
{
"success":true,
"project":
{
"id":"2119da13-f748-4741-3858-573caddda034",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 18:41:45",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"prj_uid":"2119da13-f748-4741-3858-573caddda034",
"prj_target_namespace":null,
"prj_expression_language":null,
"prj_type_language":null,
"prj_exporter":null,
"prj_exporter_version":null,
"prj_author":null,
"prj_author_version":null,
"prj_original_source":null,
"prj_status":"INACTIVE",
"prj_module":"Accounts",
"team_id":"1",
"team_set_id":"1",
"team_set_selected_id":"",
"assigned_user_id":"1",
"au_first_name":null,
"au_last_name":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-1 | "au_first_name":null,
"au_last_name":"Administrator",
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"tn_name":"Global",
"tn_name_2":"",
"my_favorite":null,
"following":"0",
"pro_id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"diagram":
[
{
"id":"9ce21d87-f81a-5be2-86e8-573cad955d06",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"dia_uid":"343198086573cad309cc1d6078585899",
"prj_id":"2119da13-f748-4741-3858-573caddda034",
"dia_is_closable":"0",
"assigned_user_id":"1",
"activities":
[
{
"id":"9ce21d87-f81a-5be2-86e8-573cad955d06",
"name":"PD_AC",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-2 | "date_modified":"2016-05-18 17:58:07",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"dia_uid":"343198086573cad309cc1d6078585899",
"prj_id":"2119da13-f748-4741-3858-573caddda034",
"dia_is_closable":"0",
"assigned_user_id":"1",
"activities":
[
{
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:45",
"created_by":"1",
"description":"",
"deleted":"0",
"act_uid":"552527013573cb7565825f2050463919",
"act_type":"TASK",
"act_is_for_compensation":"0",
"act_start_quantity":"1",
"act_completion_quantity":"0",
"act_task_type":"SCRIPTTASK",
"act_implementation":"",
"act_instantiate":"0",
"act_script_type":"CHANGE_FIELD",
"act_script":"",
"act_loop_type":"NONE",
"act_test_before":"0",
"act_loop_maximum":"0",
"act_loop_condition":"",
"act_loop_cardinality":"0",
"act_loop_behavior":"",
"act_is_adhoc":"0",
"act_is_collapsed":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-3 | "act_is_adhoc":"0",
"act_is_collapsed":"0",
"act_completion_condition":"",
"act_ordering":"PARALLEL",
"act_cancel_remaining_instances":"1",
"act_protocol":"",
"act_method":"",
"act_is_global":"0",
"act_referer":"",
"act_default_flow":"0",
"act_master_diagram":"",
"bou_x":"245",
"bou_y":"106",
"bou_width":"35",
"bou_height":"35",
"bou_container":"bpmnDiagram",
"act_name":"Action # 1"
}
],
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:45",
"created_by":"1",
"description":"",
"deleted":"0",
"act_uid":"552527013573cb7565825f2050463919",
"act_type":"TASK",
"act_is_for_compensation":"0",
"act_start_quantity":"1",
"act_completion_quantity":"0",
"act_task_type":"SCRIPTTASK",
"act_implementation":"",
"act_instantiate":"0",
"act_script_type":"CHANGE_FIELD",
"act_script":"",
"act_loop_type":"NONE",
"act_test_before":"0",
"act_loop_maximum":"0",
"act_loop_condition":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-4 | "act_loop_maximum":"0",
"act_loop_condition":"",
"act_loop_cardinality":"0",
"act_loop_behavior":"",
"act_is_adhoc":"0",
"act_is_collapsed":"0",
"act_completion_condition":"",
"act_ordering":"PARALLEL",
"act_cancel_remaining_instances":"1",
"act_protocol":"",
"act_method":"",
"act_is_global":"0",
"act_referer":"",
"act_default_flow":"0",
"act_master_diagram":"",
"bou_x":"245",
"bou_y":"106",
"bou_width":"35",
"bou_height":"35",
"bou_container":"bpmnDiagram",
"act_name":"Action # 1"
}
],
"events":
[
{
"id":"80a37c82-8be8-c668-a547-573cb791b905",
"name":"Start Event # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:29",
"created_by":"1",
"description":"",
"deleted":"0",
"evn_uid":"632263607573cb74a582507093735454",
"evn_type":"START",
"evn_marker":"MESSAGE",
"evn_is_interrupting":"1",
"evn_attached_to":"",
"evn_cancel_activity":"0",
"evn_activity_ref":"",
"evn_wait_for_completion":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-5 | "evn_activity_ref":"",
"evn_wait_for_completion":"1",
"evn_error_name":"",
"evn_error_code":"",
"evn_escalation_name":"",
"evn_escalation_code":"",
"evn_condition":"",
"evn_message":"",
"evn_operation_name":"",
"evn_operation_implementation":"",
"evn_time_date":"",
"evn_time_cycle":"",
"evn_time_duration":"",
"evn_behavior":"CATCH",
"bou_x":"132",
"bou_y":"108",
"bou_width":"33",
"bou_height":"33",
"bou_container":"bpmnDiagram",
"evn_name":"Start Event # 1"
},
{
"id":"82894d13-1af8-f039-2cd3-573cb755559e",
"name":"End Event # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:29",
"created_by":"1",
"description":"",
"deleted":"0",
"evn_uid":"282428179573cb7585826d6045140545",
"evn_type":"END",
"evn_marker":"EMPTY",
"evn_is_interrupting":"1",
"evn_attached_to":"",
"evn_cancel_activity":"0",
"evn_activity_ref":"",
"evn_wait_for_completion":"1",
"evn_error_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-6 | "evn_wait_for_completion":"1",
"evn_error_name":"",
"evn_error_code":"",
"evn_escalation_name":"",
"evn_escalation_code":"",
"evn_condition":"",
"evn_message":"",
"evn_operation_name":"",
"evn_operation_implementation":"",
"evn_time_date":"",
"evn_time_cycle":"",
"evn_time_duration":"",
"evn_behavior":"THROW",
"bou_x":"349",
"bou_y":"107",
"bou_width":"33",
"bou_height":"33",
"bou_container":"bpmnDiagram",
"evn_name":"End Event # 1"
}
],
"gateways":[],
"artifacts":[],
"flows":
[
{
"id":"974e5216-9d76-5e30-7241-573cb73b7761",
"name":"",
"date_entered":"2016-05-18 18:41:36",
"date_modified":"2016-05-18 18:41:36",
"created_by":"1",
"description":"",
"deleted":"0",
"flo_uid":"287649205573cb75b582a78086279138",
"flo_type":"SEQUENCE",
"flo_element_origin":"632263607573cb74a582507093735454",
"flo_element_origin_type":"bpmnEvent",
"flo_element_origin_port":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-7 | "flo_element_origin_port":"0",
"flo_element_dest":"552527013573cb7565825f2050463919",
"flo_element_dest_type":"bpmnActivity",
"flo_element_dest_port":"0",
"flo_is_inmediate":"",
"flo_condition":"",
"flo_eval_priority":"0",
"flo_x1":"165",
"flo_y1":"125",
"flo_x2":"243",
"flo_y2":"122",
"flo_state":
[
{
"x":165,
"y":125
},
{
"x":204,
"y":125
},
{
"x":204,
"y":122
},
{
"x":243,
"y":122
}
],
"prj_id":"2119da13-f748-4741-3858-573caddda034"
},
{
"id":"9fc25911-3e2d-89f1-8d37-573cb73639bd",
"name":"",
"date_entered":"2016-05-18 18:41:36",
"date_modified":"2016-05-18 18:41:36",
"created_by":"1",
"description":"",
"deleted":"0",
"flo_uid":"121706749573cb75d582c86016080199",
"flo_type":"SEQUENCE",
"flo_element_origin":"552527013573cb7565825f2050463919",
"flo_element_origin_type":"bpmnActivity", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-8 | "flo_element_origin_type":"bpmnActivity",
"flo_element_origin_port":"0",
"flo_element_dest":"282428179573cb7585826d6045140545",
"flo_element_dest_type":"bpmnEvent",
"flo_element_dest_port":"0",
"flo_is_inmediate":"",
"flo_condition":"",
"flo_eval_priority":"0",
"flo_x1":"282",
"flo_y1":"122",
"flo_x2":"349",
"flo_y2":"124",
"flo_state":
[
{
"x":282,
"y":122
},
{
"x":315,
"y":122
},
{
"x":315,
"y":124
},
{
"x":349,
"y":124
}
],
"prj_id":"2119da13-f748-4741-3858-573caddda034"
}
]
}
],
"process_definition":
{
"id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"name":"",
"date_entered":"2016-05-18 17:58:07",
"date_modified":"2016-05-18 17:58:07",
"created_by":"1",
"description":null,
"deleted":"0",
"pro_module":"Accounts",
"pro_status":"INACTIVE",
"pro_locked_variables":[],
"pro_terminate_variables":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-9 | "pro_locked_variables":[],
"pro_terminate_variables":"",
"execution_mode":"SYNC"
},
"prj_name":"PD_AC",
"prj_description":null,
"script_tasks":
{
"add_related_record":
{
"1":
{
"value":"members",
"text":"Accounts (Members: members)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"member_accounts"
},
"2":
{
"value":"bugs",
"text":"Bugs (Bugs: bugs)",
"module":"Bugs",
"module_label":"Bugs",
"module_name":"Bugs",
"relationship":"accounts_bugs"
},
"3":
{
"value":"calls",
"text":"Calls (Calls: calls)",
"module":"Calls",
"module_label":"Calls",
"module_name":"Calls",
"relationship":"account_calls"
},
"4":
{
"value":"cases",
"text":"Cases (Cases: cases)",
"module":"Cases",
"module_label":"Cases",
"module_name":"Cases",
"relationship":"account_cases"
},
"5":
{
"value":"contacts",
"text":"Contacts (Contacts: contacts)",
"module":"Contacts",
"module_label":"Contacts",
"module_name":"Contacts",
"relationship":"accounts_contacts"
},
"6":
{
"value":"contracts",
"text":"Contracts (Contracts: contracts)", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-10 | "value":"contracts",
"text":"Contracts (Contracts: contracts)",
"module":"Contracts",
"module_label":"Contracts",
"module_name":"Contracts",
"relationship":"account_contracts"
},
"7":
{
"value":"documents",
"text":"Documents (Documents: documents)",
"module":"Documents",
"module_label":"Documents",
"module_name":"Documents",
"relationship":"documents_accounts"
},
"8":
{
"value":"leads",
"text":"Leads (Leads: leads)",
"module":"Leads",
"module_label":"Leads",
"module_name":"Leads",
"relationship":"account_leads"
},
"9":
{
"value":"meetings",
"text":"Meetings (Meetings: meetings)",
"module":"Meetings",
"module_label":"Meetings",
"module_name":"Meetings",
"relationship":"account_meetings"
},
"10":
{
"value":"notes",
"text":"Notes (Notes: notes)",
"module":"Notes",
"module_label":"Notes",
"module_name":"Notes",
"relationship":"account_notes"
},
"11":
{
"value":"opportunities",
"text":"Opportunities (Opportunity: opportunities)",
"module":"Opportunities",
"module_label":"Opportunities",
"module_name":"Opportunities",
"relationship":"accounts_opportunities"
},
"12":
{
"value":"project", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
4238c8026138-11 | },
"12":
{
"value":"project",
"text":"Projects (Projects: project)",
"module":"Projects",
"module_label":"Projects",
"module_name":"Project",
"relationship":"projects_accounts"
},
"13":
{
"value":"products",
"text":"Quoted Line Items (Products: products)",
"module":"Quoted Line Items",
"module_label":"Quoted Line Items",
"module_name":"Products",
"relationship":"products_accounts"
},
"14":
{
"value":"quotes_shipto",
"text":"Quotes (Quotes Ship to: quotes_shipto)",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"quotes_shipto_accounts"
},
"15":
{
"value":"quotes",
"text":"Quotes (Quotes: quotes)",
"module":"Quotes",
"module_label":"Quotes",
"module_name":"Quotes",
"relationship":"quotes_billto_accounts"
},
"16":
{
"value":"tasks",
"text":"Tasks (Tasks: tasks)",
"module":"Tasks",
"module_label":"Tasks",
"module_name":"Tasks",
"relationship":"account_tasks"
}
}
}
}
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_GET/index.html |
5ea8786fc528-0 | /pmse_Project/project/:record PUT
Overview
Updates the schema data from the Process Definition designer
Summary
This endpoint will update the Process Definition identified by the
record input parameter with data provided in the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Request Payload
{
"data":
{
"activities":{},
"gateways":
{
"407410601573ce3125db315056173234":
{
"action":"REMOVE",
"gat_uid":"407410601573ce3125db315056173234"
}
},
"events":{},
"artifacts":{},
"flows":{},
"prj_uid":"2119da13-f748-4741-3858-573caddda034"
},
"id":"2119da13-f748-4741-3858-573caddda034",
"operation":"update",
"wrapper":"Project"
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
"success":true
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_PUT/index.html |
6cc2a67fb7ee-0 | /Emails/count GET
Overview
Lists filtered emails.
Summary
Adds additional operators to Filter API that are
specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails
involving the current user.
Filter By Sender
This will return all emails sent by the current user, by the contact whose ID is
fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address sam@example.com, which is referenced by
the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is
73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address wally@example.com, which is referenced by
the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.
{
"filter": [{
"$from": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html |
6cc2a67fb7ee-1 | "email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
"email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}
}]
}
Filter By Recipients
This would return all archived emails received by the current user.
{
"filter": [{
"$or": [{
"$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}]
}, {
"state": {
"$in": [ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html |
6cc2a67fb7ee-2 | }]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Filter By Sender and Recipients
This would return all archived emails sent by a contact to the current user.
{
"filter": [{
"$from": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}, {
"$or": [{
"$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}]
}, {
"state": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html |
6cc2a67fb7ee-3 | }]
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}
}, {
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Change Log
Version
Change
v10
Added the $from, $to, $cc, and $bcc operators to
/Emails/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailscount_GET/index.html |
821eda6ab2a7-0 | /Forecasts/reportees/:user_id GET
ForecastsApi Reportees
Summary:
This endpoint is used to return the json Data for an array of users and their state for the forecasts users tree filter
Query Parameters:
Param
Description
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
level
Level of child notes, defaults to 1, -1 for all levels
Optional
Input Example:
{
'user_id':'seed_max_id'
}
Output Example:
{
"attr":{
"id":"jstree_node_jim",
"rel":"root"
},
"children":[
{
"attr":{
"id":"jstree_node_myopps_jim",
"rel":"my_opportunities"
},
"children":[
],
"data":"Opportunities (Jim Brennan)",
"metadata":{
"first_name":"Jim",
"full_name":"Jim Brennan",
"id":"seed_jim_id",
"last_name":"Brennan",
"level":"1",
"reports_to_id":"",
"user_name":"jim"
},
"state":""
},
{
"attr":{
"id":"jstree_node_will",
"rel":"manager"
},
"children":[
],
"data":"Will Westin",
"metadata":{
"first_name":"Will",
"full_name":"Will Westin",
"id":"seed_will_id",
"last_name":"Westin",
"level":"2",
"reports_to_id":"seed_jim_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html |
821eda6ab2a7-1 | "level":"2",
"reports_to_id":"seed_jim_id",
"user_name":"will"
},
"state":"closed"
},
{
"attr":{
"id":"jstree_node_sarah",
"rel":"manager"
},
"children":[
],
"data":"Sarah Smith",
"metadata":{
"first_name":"Sarah",
"full_name":"Sarah Smith",
"id":"seed_sarah_id",
"last_name":"Smith",
"level":"2",
"reports_to_id":"seed_jim_id",
"user_name":"sarah"
},
"state":"closed"
}
],
"data":"Jim Brennan",
"metadata":{
"first_name":"Jim",
"full_name":"Jim Brennan",
"id":"seed_jim_id",
"last_name":"Brennan",
"level":"1",
"reports_to_id":"",
"user_name":"jim"
},
"state":"open"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.