id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
e782952a46e7-0 | /<module>/recent-product GET
Overview
Opportunity Recent Product Help
Summary
This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the
"Product Catalog Quick Picks" dashlet in the reverse chronological order.
Request Arguments
None
Response Arguments
NONE
Response
{
"next_offset":-1,
"records":[
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html |
e782952a46e7-1 | "status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html |
e782952a46e7-2 | "list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html |
e782952a46e7-3 | "vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html |
e782952a46e7-4 | "category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html |
e782952a46e7-5 | "description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/recent_product 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/modulerecent-product_GET/index.html |
22a5db7f7973-0 | /ForecastManagerWorksheets/export GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[
"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"b3e87a3f-cd8f-7b86-467a-512d09e8d240"
]
}
Exporting Records Using a Filter
{
"filter":[
{
"name":"airline"
}
]
}
Exporting a Sample Result Set
{
"sample":true
}
Response Arguments
Name
Type
Description
<csv export>
String
Returns the selected records in CSV format with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html |
22a5db7f7973-1 | X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8
"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html |
22a5db7f7973-2 | "Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""
Change Log
Version
Change
v10
Added /<module>/export 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/ForecastManagerWorksheetsexport_GET/index.html |
c2da72370247-0 | /Users 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
The number of records to skip over before records are returned. Default is 0. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Users_GET/index.html |
c2da72370247-1 | 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/Users_GET/index.html |
c2da72370247-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/Users_GET/index.html |
c2da72370247-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/Users_GET/index.html |
c2da72370247-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/Users_GET/index.html |
c2da72370247-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/Users_GET/index.html |
3e91b8c18d59-0 | /pmse_Emails_Templates/file/emailtemplates_import POST
Overview
Imports a Process Email Templates definition from a .pet file
Summary
This endpoint will import a Process Email Templates definition from the
uploaded .pet file containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
N/A
Request
Note: A JSON encoded .pet file attachment should be included with
the request as part of the form-data.
Response Arguments
Name
Type
Description
emailtemplates_import
Object
Result of the import operation
Response
{
"emailtemplates_import":
{
"success":true,
"id":"aa5f7fd9-73a9-8338-fd1a-573635ce5c51"
}
}
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_Emails_Templatesfileemailtemplates_import_POST/index.html |
77cde83b7c06-0 | /<module>/sync_key/:sync_key_field_value DELETE
Overview
Deletes the record with the given sync_key.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was deleted.
Response
Status 200
{ "id": "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /<module>/sync_key/:sync_key_field_value DELETE 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/modulesync_keysync_key_field_value_DELETE/index.html |
817cdd7b7c27-0 | /pmse_Inbox/casesList GET
Overview
Returns a list with the processes for Process Management
Summary
This endpoint gets a list of Processes.
Request Arguments
Name
Type
Description
Required
module_list
string
Identifier used to determine which status to filter against
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.
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
filter
string
The filter expression
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
The number of records to skip over before records are returned. Default is 0.
false
fields
string
Comma delimited list of fields to return
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
next_offset
Integer
Next offset
records
<field>/<value>
List of process attributes
Response
{
{
"next_offset":-1,
"records":
[
{
"id":"3922976c-284f-11e6-9f40-6c4008960436",
"name":"ABC2",
"date_entered":"2016-06-01T16:18:59-07:00",
"date_modified":"2016-06-01T16:18:59-07:00",
"modified_user_id":"1",
"created_by":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html |
817cdd7b7c27-1 | "modified_user_id":"1",
"created_by":"1",
"deleted":"0",
"cas_id":"2",
"cas_parent":"0",
"cas_status":"IN PROGRESS",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_title":"ABC2",
"cas_custom_status":"",
"cas_init_user":"1",
"cas_create_date":"2016-06-01T16:18:59-07:00",
"cas_update_date":"2016-06-01 23:18:59",
"cas_finish_date":null,
"cas_assigned_status":"UNASSIGNED",
"cas_module":"Accounts",
"team_id":"1",
"team_set_id":"1",
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
"prj_created_by":"1",
"prj_module":"Accounts",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"38beb03a-284f-11e6-b059-6c4008960436",
"pro_title":"PD1",
"prj_deleted":"0",
"prj_user_id_full_name":"Administrator",
"cas_user_id_full_name":"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_InboxcasesList_GET/index.html |
cde14a186ed3-0 | /Mail/attachment/:file_guid DELETE
Overview
Delete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with a bool of true.
Change Log
Version
Change
v11
Last version in which /Mail/attachment/:file_guid DELETE is available. Use
/Notes/:id/file/filename DELETE to delete a file from the filesystem. Use
/Emails/:record/link/attachments/:remote_id DELETE to remove an attachment from an
email. Note that removing an attachment from an email will also delete it from the filesystem.
v10
Added /Mail/attachment/:file_guid DELETE 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/Mailattachmentfile_guid_DELETE/index.html |
85188288b16c-0 | /me PUT
Overview
Returns the current user object.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Response User Example
{
"current_user":{
"type":"user",
"id":"1",
"full_name":"Administrator",
"timepref":"h:ia",
"timezone":"America/Los_Angles",
"user_name":"admin"
}
}
Response Portal User Example
{
"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 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/me_PUT/index.html |
c5c7bdf428e8-0 | /Administration/config/:category GET
Overview
[ADMIN] Get Configuration Settings for a Category.
Summary
This endpoint gets configuration values for a given category. This endpoint is only available to administrators.
Request
GET /Administration/config/:category
Â
Response Example
{
"a_config": "good"
}
Change Log
Version
Change
v11.13
Added Administration/config/:category 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/Administrationconfigcategory_GET/index.html |
244a74bfc90e-0 | /Administration/packages GET
Overview
[ADMIN] PackageManager list packages.
Summary
Lists all packages in the system.
Response
{
"packages": [
{
"name": "project_P3",
"version": "1580885734",
"type": "module",
"published_date": "2020-02-06 12:51:17",
"description": "",
"uninstallable": true,
"file_install": "cd590eb069a73b2eeb6c107776fd60dc",
"file": "cd590eb069a73b2eeb6c107776fd60dc",
"enabled": "ENABLED",
"id": "66172e0e-48df-11ea-9f1f-acde48001122",
"installed": true
},
{
"name": "project_P1",
"version": 1580885419,
"published_date": "2020-02-05 06:50:19",
"description": "None",
"uninstallable": "Yes",
"type": "Module",
"file": "0ef4dd8b237f4358bdb246a744eb2b38",
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392",
"installed": false
}
]
}
Change Log
Version
Change
v11.8
Added /Administration/packages 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/Administrationpackages_GET/index.html |
5a6c2a15d4c8-0 | /<module>/Activities GET
Activities on a module's list view
Summary:
This endpoint lists activities across a particular module in the system. 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/moduleActivities_GET/index.html |
5a6c2a15d4c8-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/moduleActivities_GET/index.html |
ddf3682cf80c-0 | /<module>/count 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/modulecount_GET/index.html |
ddf3682cf80c-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/modulecount_GET/index.html |
ddf3682cf80c-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/modulecount_GET/index.html |
ddf3682cf80c-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/modulecount_GET/index.html |
ddf3682cf80c-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/modulecount_GET/index.html |
ddf3682cf80c-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/modulecount_GET/index.html |
306803ca7f6b-0 | /Mail POST
Overview
Create an email and send or save as draft.
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
email_config
String
ID of the outbound email configuration to use when sending this email
True
to_addresses
Array
Array of name/email address pairs for the TO field, when present, only email subfield is required (not name).
True
cc_addresses
Array
Array of name/email address pairs for the CC field, when present, email subfield is required.
False
bcc_addresses
Array
Array of name/email address pairs for the BCC field, when present, email subfield is required.
False
subject
String
Subject of the email
False
html_body
String
HTML body of the email
False
text_body
String
Text body of the email
False
status
String
Indicates the status of the email - 'draft' or 'ready' (ready to be sent)
True
related
Object
Contains 'parent_type' and 'parent_id' to relate this email to (for example 'Contact' and a contact's id)
False
teams
Object | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
306803ca7f6b-1 | False
teams
Object
Team(s) to assign this email to. 'primary' attribute is an id string for the primary team and 'other' attribute is an array of id strings for the other teams - only primary is required
True
attachments
Array
Array of file attachments - each attachment consists of a 'type' (where the attachment came from: upload, document, or template), 'id' (of the file upload, note, document revision, etc), and 'name' (the file name)
False
Input Example
{
"email_config":"abc181a2-5c05-b879-8e68-502279a8c401",
"to_addresses":[
{
"name":"John Doe",
"email":"[email protected]"
},
{
"name":"David Madison",
"email":"[email protected]"
}
],
"cc_addresses":[
{
"name":"Tom Swift",
"email":"[email protected]"
}
],
"bcc_addresses":null,
"subject":"Minneapolis Convention",
"html_body":"<html><body>Hello World<\/body><\/html>",
"text_body":"Hello World"
"status":"ready",
"related": {
"type":"Contacts",
"id":"61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b"
},
"teams": {
"primary": "dabec868-696c-f458-e204-50227995ab50", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
306803ca7f6b-2 | "others": [
"c3094c88-c95f-2e17-4553-50227996ad20",
"abcde868-696c-f458-e704-58369095ab62"
]
},
"attachments": [
{
"type": "upload",
"id": "cfbe4551-548d-f602-b228-45387645fc12",
"name": "company_logo.jpg"
},
{
"type": "document",
"id": "876112a4-89c1-4ba7-a05a-7729a7a76818"
},
{
"type": "template",
"id": "002cfe6c-98e9-4342-bdb1-1660d0788872"
}
],
}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example
{
"team_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"team_set_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"id": "d9c165d0-8863-ba61-dc85-51ed8016c476",
"date_entered": "2013-07-22 18:57:57",
"date_modified": "2013-07-22 18:57:57",
"assigned_user_id": "1",
"assigned_user_name": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mail_POST/index.html |
306803ca7f6b-3 | "assigned_user_id": "1",
"assigned_user_name": "",
"modified_user_id": "1",
"modified_by_name": "admin",
"created_by": "1",
"created_by_name": "",
"deleted": 0,
"from_addr_name": "SugarCRM",
"reply_to_addr": "",
"to_addrs_names": "[email protected], [email protected]",
"cc_addrs_names": "[email protected]",
"description_html": "<html><body>Hello World<\/body><\/html>",
"description": "Hello World",
"date_sent": "2013-07-22 18:57:00",
"name": "Minneapolis Convention",
"type": "out",
"status": "sent",
"parent_type": "Contacts",
"parent_id": "61cf0f8d-938c-c9b2-53ad-51ed7bbcf83b",
}
Change Log
Version
Change
v11
Last version in which /Mail POST is available. Use /Emails POST instead.
v10
Added /Mail 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/Mail_POST/index.html |
d701e06a4d6f-0 | /ForecastWorksheets/export GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[
"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"b3e87a3f-cd8f-7b86-467a-512d09e8d240"
]
}
Exporting Records Using a Filter
{
"filter":[
{
"name":"airline"
}
]
}
Exporting a Sample Result Set
{
"sample":true
}
Response Arguments
Name
Type
Description
<csv export>
String
Returns the selected records in CSV format with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
d701e06a4d6f-1 | X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8
"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
d701e06a4d6f-2 | "Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""
Change Log
Version
Change
v10
Added /<module>/export 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/ForecastWorksheetsexport_GET/index.html |
8a1bfaa4fc48-0 | /Administration/elasticsearch/replicas/enable POST
Overview
[ADMIN] Elasticsearch enable replicas
Summary
Enable replicas for all indices managed by SugarCRM. This endpoint is only
available to administrators. This requires reindex_zero_replica to be enabled.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/replicas/enable 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/Administrationelasticsearchreplicasenable_POST/index.html |
c741827928ca-0 | /<module>/:record/pii GET
Overview
Returns personally identifiable information (pii) fields with current data and source of data capture for a specific record.
Version Requirements
Minimum REST API Version required - 11.1
Request Arguments
Name
Type
Description
Required
module
String
The name of the module.
True
record
String
The record id.
True
Response Arguments
Name
Type
Description
records
String
Returns the set of PII field records for the given module record.
Response
{
"fields": [
{
"field_name": "phone_mobile",
"value": "(645) 604-0128",
"event_type": "update",
"date_modified": "2018-02-21T19:56:42+00:00",
"source": {
"subject": {
"_type": "user",
"id": "999b3b50-16dc-11e8-9c03-a45e60e64123",
"_module": "Users",
"client": {
"_type": "rest-api"
},
"first_name": "Tim",
"last_name": "Zhang",
"name": "Tim Zhang"
},
"attributes": {
"platform": "base"
}
}
},
{
"field_name": "phone_work",
"value": "(212) 692-3480",
"event_type": "update", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html |
c741827928ca-1 | "event_type": "update",
"date_modified": "2018-02-21T19:56:42+00:00",
"source": {
"subject": {
"_type": "user",
"id": "654b3b50-16dc-11e8-9c03-a45e60e64465",
"_module": "Users",
"client": {
"_type": "rest-api"
},
"first_name": "Jim",
"last_name": "Conners",
"name": "Jim Conners"
},
"attributes": {
"platform": "base"
}
}
}
]
}
Change Log
Version
Change
11.1
Added /pii 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/modulerecordpii_GET/index.html |
80be9109b419-0 | /Forecasts/:timeperiod_id/quotas/rollup/:user_id GET
ForecastsQuotasApi - Get
Summary:
This endpoint is used to return quota information for a specific user ID, in a specific timeperiod and by a specifc type..
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Required
quota_type
"rollup" or "direct" quota
Required
user_id
Show for a specific user
Required
Input Example:
Output Example:
{
"currency_id":"-99",
"amount":"75.000000",
"date_modified":"2013-09-17 21:23:32",
"formatted_amount":"$75.00",
"is_top_level_manager":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/Forecaststimeperiod_idquotasrollupuser_id_GET/index.html |
4963ad8e6f53-0 | /<module>/:record/prev GET
Overview
Retrieves previous sibling of selected record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
{
id: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
name: "SugarCategoryExample"
date_entered: "2014-09-12 10:47:46"
date_modified: "2014-09-12 10:47:46"
modified_user_id: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
created_by: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
description: null
deleted: "0"
source_id: null
source_type: null
source_meta: null
root: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
lft: "6"
rgt: "11"
level: "1"
}
Change Log
Version
Change
v10
Added /<module>/:record/prev 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/modulerecordprev_GET/index.html |
f1256362353b-0 | /Dashboards/<module> GET
Overview
List current user's filtered dashboards.
Summary
This endpoint will return a set of dashboards 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, currently the definition will override the id,
but please do not rely on this behavior as it is subject to change. 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.
Notice
This endpoint is not supported in v11. If you continue to use v10 of the API, your
REST calls should behave as below. But, it is advisable to upgrade to v11.Migrating to v11:
For more information on behavior in v11, refer to GET /<module>.
Recommended Replacement:
GET /Dashboards
The module name is no longer part of the path. To specify a module name, include it as a filter
parameter. For example, to retrieve all dashboards from the Accounts module, usev11:
GET /Dashboards?filter[0][dashboard_module]=Accounts
name, id. etc. are no longer specified as default fields. To retain the default fields, usev11:
GET /Dashboards?filter[0][dashboard_module]=Accounts&fields=id,name,view_name
Request Arguments
Name
Type
Description
Required
filter
String
See Filter API.
False
filter_id
String
Identifier for a preexisting filter. See
the Filter API for details.
False
max_num
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_GET/index.html |
f1256362353b-1 | the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20.
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.
For more details on additional field parameters, see
Relate API and
Collection API.
False
order_by
String
See Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
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.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"records": [
{
"id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
"name": "Accounts Dashboard",
"date_modified": "2016-03-29T09:46:00-07:00",
"view_name": "records",
"_acl": {
"fields": {}
},
"view": "records",
"_module": "Dashboards"
},
{
"id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
"name": "Contacts Dashboard", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsmodule_GET/index.html |
f1256362353b-2 | "name": "Contacts Dashboard",
"date_modified": "2016-03-29T09:57:58-07:00",
"view_name": "records",
"_acl": {
"fields": {}
},
"view": "records",
"_module": "Dashboards"
}
]
}
Change Log
Version
Change
v11
No longer supported. Please use GET /Dashboards instead.
v10
Added /Dashboards/<module> 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/Dashboardsmodule_GET/index.html |
8593ae8c41b0-0 | /Calls/:record PUT
Overview
Update a calendar event record of the specified type.
Request Arguments
Name
Type
Description
Required
all_recurrences
Boolean
Flag to update all events in a series.
False
Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
{
"name":"Department Meeting",
"description":"Weekly Department Meeting",
"date_start":"yyyy-mm-ddThh:mm:ss-00:00",
"date_end":"yyyy-mm-ddThh:mm:ss-00:00",
"repeat_type":"Weekly",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the updated record.
Response
{
}
Change Log
Version
Change
v10
Added /<module>/:record 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/Callsrecord_PUT/index.html |
2c7adb64440a-0 | /RevenueLineItems/multi-quote POST
Convert Multiple Revenue Line Item to a quote.
Summary:
This endpoint is used to convert multiple Revenue Line Items to a single quote
Query Parameters:
Param
Description
Optional
Valid Urls:
POST: /rest/v10/RevenueLineItems/multi-quote
Input Example:
{
records : [
'id_1',
'id_2',
]
opportunity_id:"123-456-789-0",
account_id:"12-3-4-5"
}
Output Example:
{
id:"123-456-789-0",
name:"My Test Quote"
}
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/RevenueLineItemsmulti-quote_POST/index.html |
35b973280bbf-0 | /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT
Overview
Sets a sync key value for a record. Note that the PATCH method is recommended over the PUT method.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
record_id
String
The ID of the record whose sync key will be set
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value
Response
{"success": true}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value 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/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PUT/index.html |
eb0e5b4e04e2-0 | /CommentLog/:record GET
Overview
Retrieves a record.
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":"",
"googleplus":"",
"account_type":"Customer", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
eb0e5b4e04e2-1 | "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":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
eb0e5b4e04e2-2 | "opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record 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/CommentLogrecord_GET/index.html |
4a7315a673f7-0 | /pmse_Inbox/AdhocReassign/:data/:flowId GET
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
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_InboxAdhocReassigndataflowId_GET/index.html |
ff6744f3d102-0 | /oauth2/sudo/:user_name POST
Overview
Get an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition.
Request Arguments
Name
Type
Description
Required
platform
String
Which platform on the session, defaults to "base"
False
client_id
String
The client id for the session, defaults to "sugar"
False
Request
{
"client_id":"sugar",
"platform":"base"
}
Response Arguments
Name
Type
Description
access_token
String
The access token needed to authenticate for other methods.
expires_in
Integer
The length of time until the access_token expires.
token_type
String
Should always be bearer.
scope
String
There is no scope implementation in the current release of Sugar.
Response
{
"access_token":"c19fff9b-b767-233e-ebb4-512e369d3e39",
"expires_in":3600,
"token_type":"bearer",
"scope":null
}
Change Log
Version
Change
v10
Added /oauth2/token/sudo/:user 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/oauth2sudouser_name_POST/index.html |
46c6e9b73774-0 | /Administration/license/limits GET
Overview
[ADMIN] Get License Limits.
Summary
This endpoint gets the license limits, the number of unused licensed seats for each license type. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"default_limit": 100,
"limit_enforced": 1,
"default_license_type" : "CURRENT",
"seats": {
"CURRENT": 100,
"SUGAR_SERVE": 10
},
"available_seats": {
"CURRENT": 25,
"SUGAR_SERVE": 1,
"SUGAR_SELL": 0
}
}
Change Log
Version
Change
v11_2
Added /Administration/license/limits 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/Administrationlicenselimits_GET/index.html |
2b4e317cd747-0 | /<module>/duplicateCheck POST
Overview
Runs a duplicate check against specified data.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Airline"
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the potential duplicate records.
Response
{
"next_offset":-1,
"records":[
{
"id":"c4c26496-5dbc-67dd-bf5c-512d0923889e",
"name":"Airline Maintenance Co",
"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_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html |
2b4e317cd747-1 | "name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Other",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"123 Anywhere Street",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"Sunnyvale",
"billing_address_state":"CA",
"billing_address_postalcode":"48566",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(648) 452-3486",
"phone_alternate":"",
"website":"www.kidqa.it",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"123 Anywhere Street",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"Sunnyvale",
"shipping_address_state":"CA",
"shipping_address_postalcode":"48566",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html |
2b4e317cd747-2 | "invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
},
"duplicate_check_rank":0
}
]
}
Change Log
Version
Change
v10
Added /<module>/duplicateCheck 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/moduleduplicateCheck_POST/index.html |
34e5b48be8dc-0 | /integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCH
Overview
Upserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it.
Note:Â This endpoint cannot be used to set the sync_key_field_name for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:sync_key_field_name/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was upserted.
Response
Status 201: For a created record
Status 200: For an updated record
{ record: "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCH 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/Integratemodulesync_key_field_namesync_key_field_value_PATCH/index.html |
c18259ae4aab-0 | /pmse_Inbox/AdhocReassign PUT
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
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_InboxAdhocReassign_PUT/index.html |
b4a95edf69ac-0 | /Currencies GET
Returns a collection of Currency models
Summary:
This end point is used to return the Currencies defined in the application
Url Parameters:
Param
Description
Optional
Possible Errors
Error
Description
Url Example:
/rest/v10/Currencies
Output Example:
{
"next_offset": -1,
"records": [
{
"id": "-99",
"name": "US Dollars",
"symbol": "$",
"iso4217": "USD",
"conversion_rate": 1,
"status": "Active",
"_acl": {
"fields": {}
},
"_module": "Currencies"
},
{
"id": "a3cba348-756c-935c-66ad-55d772c7960f",
"name": "Euro",
"symbol": "â¬",
"iso4217": "EUR",
"conversion_rate": 0.9,
"status": "Active",
"date_modified": "2015-08-21T11:47:51-07:00",
"created_by": "1",
"_acl": {
"fields": {}
},
"_module": "Currencies"
}
]
}
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/Currencies_GET/index.html |
918b55d35378-0 | /<module>/:record/next GET
Overview
Retrieves next sibling of selected record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
{
id: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
name: "SugarCategoryExample"
date_entered: "2014-09-12 10:47:46"
date_modified: "2014-09-12 10:47:46"
modified_user_id: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
created_by: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
description: null
deleted: "0"
source_id: null
source_type: null
source_meta: null
root: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
lft: "6"
rgt: "11"
level: "1"
}
Change Log
Version
Change
v10
Added /<module>/:record/next 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/modulerecordnext_GET/index.html |
9d415d5161ff-0 | /<module>/:record/link/:link_name/:remote_id GET
Overview
Retrieves a related record with relationship role information.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"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/modulerecordlinklink_nameremote_id_GET/index.html |
9d415d5161ff-1 | "email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"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/modulerecordlinklink_nameremote_id_GET/index.html |
9d415d5161ff-2 | "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":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id 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/modulerecordlinklink_nameremote_id_GET/index.html |
8c1049221ad8-0 | /Emails/filter/count POST
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.
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
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-1 | 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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-2 | 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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-3 | 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
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_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03: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":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-4 | "primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-5 | "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":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"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":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-6 | "name":"Florence Haddock",
"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":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-7 | "primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"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":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_POST/index.html |
8c1049221ad8-8 | "reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"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":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter 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/Emailsfiltercount_POST/index.html |
8533c99067da-0 | /ConsoleConfiguration/default-metadata GET
Overview
Gets the request metadata in JSON format.
Request Arguments
This endpoint does not accept any request arguments.
URL Parameters
Parameter
Description
Required?
modules
String. Comma-separated module names. Example: 'Accounts,Opportunities'.
Yes
type
String. The type of the desired metadata. The following types are supported: 'filter', 'layout', 'menu', 'view'.
Yes
name
String. The name of the metadata. Examples: 'list', 'record', or 'multi-line-list'.
Yes
URL Example
/rest/v11_9/ConsoleConfiguration/default-metadata?modules=Cases&type=view&name=multi-line-list
Result Arguments
Response
{
"Cases":{
"panels":[
{
"label":"LBL_PANEL_1",
"fields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"width":"xsmall",
"subfields":[
{
"name":"case_number",
"label":"LBL_AGENT_WORKBENCH_NUMBER",
"default":true,
"enabled":true,
"readonly":true
}
]
},
{
"name":"status",
"label":"LBL_AGENT_WORKBENCH_PRIORITY_STATUS",
"width":"small",
"subfields":[
{
"name":"priority",
"label":"LBL_LIST_PRIORITY",
"default":true,
"enabled":true,
"type":"enum"
},
{
"name":"status",
"label":"LBL_STATUS",
"default":true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
8533c99067da-1 | "label":"LBL_STATUS",
"default":true,
"enabled":true,
"type":"case-status",
"widget_name":"widget_status"
}
]
},
{
"name":"follow_up_datetime",
"label":"LBL_AGENT_WORKBENCH_FOLLOW_UP",
"width":"medium",
"subfields":[
{
"name":"follow_up_datetime",
"label":"LBL_FOLLOW_UP_DATETIME",
"default":true,
"enabled":true,
"readonly":true,
"type":"follow-up-datetime-colorcoded",
"widget_name":"widget_follow_up_datetime",
"color_code_classes":{
"overdue":"expired",
"in_a_day":"soon-expired",
"more_than_a_day":"white black-text"
}
},
{
"name":"follow_up_datetime",
"label":"LBL_FOLLOW_UP_DATETIME",
"default":true,
"enabled":true,
"readonly":true,
"type":"datetimecombo"
}
]
},
{
"name":"name",
"label":"LBL_AGENT_WORKBENCH_SUBJECT_DESCRIPTION",
"width":"xlarge",
"subfields":[
{
"name":"name",
"label":"LBL_LIST_SUBJECT",
"link":false,
"default":true,
"enabled":true,
"readonly":true
},
{
"name":"description",
"default":true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
8533c99067da-2 | {
"name":"description",
"default":true,
"enabled":true,
"readonly":true,
"sortable":false
}
]
},
{
"name":"business_center",
"label":"LBL_BUSINESS_CENTER",
"width":"small",
"subfields":[
{
"name":"business_center_name",
"label":"LBL_BUSINESS_CENTER",
"link":false,
"default":true,
"enabled":true,
"readonly":true
}
]
},
{
"name":"account_name",
"label":"LBL_ACCOUNT",
"width":"medium",
"subfields":[
{
"name":"account_name",
"label":"LBL_LIST_ACCOUNT_NAME",
"module":"Accounts",
"id":"ACCOUNT_ID",
"ACLTag":"ACCOUNT",
"related_fields":[
"account_id"
],
"link":false,
"default":true,
"enabled":true
},
{
"name":"service_level",
"label":"LBL_SERVICE_LEVEL",
"type":"enum",
"enum_module":"Accounts",
"link":false,
"default":true,
"enabled":true,
"readonly":true
}
]
},
{
"name":"assigned_user_name",
"label":"LBL_ASSIGNED_TO_NAME",
"width":"small",
"subfields":[ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ConsoleConfigurationdefault-metadata_GET/index.html |
8533c99067da-3 | "width":"small",
"subfields":[
{
"name":"assigned_user_name",
"label":"LBL_ASSIGNED_TO_NAME",
"id":"ASSIGNED_USER_ID",
"link":false,
"default":true,
"enabled":true
}
]
}
]
}
],
"collectionOptions":{
"limit":100,
"params":{
"max_num":100,
"order_by":"follow_up_datetime",
"nulls_last":true
}
},
"filterDef":[
{
"status":{
"$not_in":[
"Closed",
"Rejected",
"Duplicate"
]
},
"$owner":""
}
]
}
}
Response Codes and Error Messages
All successful responses return 200.
The following error responses are possible:
403 (SugarAPIExceptionNotAuthorized)Â : Sent if the user attempts to access a module that they are forbidden to access.
422 (SugarApiExceptionInvalidParameter)Â : Sent if the user specifies an invalid type or module.
Change Log
Version
Change
v11.9
Added /ConsoleConfiguration/default-metadata 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/ConsoleConfigurationdefault-metadata_GET/index.html |
77d7d7fbe5b8-0 | /<module>/export/:record_list_id GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[
"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"b3e87a3f-cd8f-7b86-467a-512d09e8d240"
]
}
Exporting Records Using a Filter
{
"filter":[
{
"name":"airline"
}
]
}
Exporting a Sample Result Set
{
"sample":true
}
Response Arguments
Name
Type
Description
<csv export>
String
Returns the selected records in CSV format with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html |
77d7d7fbe5b8-1 | X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8
"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html |
77d7d7fbe5b8-2 | "Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""
Change Log
Version
Change
v10
Added /<module>/export 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/moduleexportrecord_list_id_GET/index.html |
8e144bbb09f0-0 | /<module>/:record/parent GET
Overview
Retrieves parent node for selected record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
{
id: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
name: "SugarCategoryExample"
date_entered: "2014-09-12 10:47:46"
date_modified: "2014-09-12 10:47:46"
modified_user_id: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
created_by: "9c9ad14e-1789-3340-f88d-5412cf551d3b"
description: null
deleted: "0"
source_id: null
source_type: null
source_meta: null
root: "e1ae8646-ac90-104a-59d6-5412cf5009b2"
lft: "6"
rgt: "11"
level: "1"
}
Change Log
Version
Change
v10
Added /<module>/:record/parent 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/modulerecordparent_GET/index.html |
a602fab375aa-0 | /<module>/:record/link/:link_name POST
Overview
Creates a related record.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"first_name":"Bill",
"last_name":"Edwards"
}
Response Arguments
Name
Type
Description
record
Array
The record associated to the newly created record.
related_record
Array
The record that was created and 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",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"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
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html |
a602fab375aa-1 | "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":{
}
}
},
"related_record":{
"id":"e1c495cb-af17-1b37-dd66-512f934fe155",
"name":"Bill Edwards",
"date_entered":"2013-02-28T17:25:00+00:00",
"date_modified":"2013-02-28T17:25:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html |
a602fab375aa-2 | "description":"",
"img":"",
"deleted":false,
"assigned_user_id":"",
"assigned_user_name":"",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Bill",
"last_name":"Edwards",
"full_name":"Bill Edwards",
"title":"",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"",
"email":[
],
"phone_mobile":"",
"phone_work":"",
"phone_other":"",
"phone_fax":"",
"email1":"",
"email2":"",
"invalid_email":"",
"email_opt_out":"",
"primary_address_street":"",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"",
"primary_address_state":"",
"primary_address_postalcode":"",
"primary_address_country":"",
"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":"",
"account_id":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html |
a602fab375aa-3 | "lead_source":"",
"account_id":"",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"",
"portal_active":false,
"portal_password":"",
"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":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name 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/modulerecordlinklink_name_POST/index.html |
a5d3f3b6f705-0 | /ForecastManagerWorksheets/filter POST
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return selective ManagerWorksheets with the optional filter parameter.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
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 an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastManagerWorksheets/filter
{
"filter":[
{"assigned_user_id" : "seed_jim_id"},
{"timeperiod_id":"e546185a-5889-ea75-84c8-511178d1a5ba"}
],
}
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",
"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": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html |
a5d3f3b6f705-1 | "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/ForecastManagerWorksheetsfilter_POST/index.html |
57196a035d2a-0 | /<module>/:record/favorite DELETE
Overview
Removes 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_DELETE/index.html |
57196a035d2a-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":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
57196a035d2a-2 | },
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite DELETE 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_DELETE/index.html |
8343803660c3-0 | /Administration/settings/auth GET
Overview
[ADMIN] Fetch auth settings.
Summary
This endpoint will return auth settings. This endpoint is only available to administrators when IDM migration is turned on.
Response if enabled only local auth provider
{
"enabledProviders": [
"local"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
}
}
Response if enabled local and ldap auth providers
{
"enabledProviders": [
"local",
"ldap"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
},
"ldap": {
"user": {
"mapping": {
"givenName": "first_name",
"sn": "last_name",
"mail": "email1",
"telephoneNumber": "phone_work",
"facsimileTelephoneNumber": "phone_fax",
"mobile": "phone_mobile", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html |
8343803660c3-1 | "mobile": "phone_mobile",
"street": "address_street",
"l": "address_city",
"st": "address_state",
"postalCode": "address_postalcode",
"c": "address_country"
}
},
"adapter_config": {
"host": "127.0.0.1",
"port": "389",
"options": {
"network_timeout": 60,
"timelimit": 60
},
"encryption": "none"
},
"adapter_connection_protocol_version": 3,
"baseDn": "dc=openldap,dc=com",
"uidKey": "uid",
"filter": "({uid_key}={username})",
"dnString": null,
"entryAttribute": null,
"autoCreateUser": "1",
"searchDn": "cn=admin,ou=admins,dc=openldap,dc=com",
"searchPassword": "admin&password"
}
}
Response if enabled local and saml auth providers
{
"enabledProviders": [
"local",
"saml"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
},
"saml": {
"strict": true, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html |
8343803660c3-2 | }
},
"saml": {
"strict": true,
"debug": false,
"sp": {
"entityId": "logoutFlowWithRedirectBinding",
"assertionConsumerService": {
"url": "http://localhost/index.php?module=Users&action=Authenticate",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
},
"singleLogoutService": {
"url": "http://localhost/index.php?module=Users&action=Logout",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
},
"NameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"x509cert": "",
"privateKey": "",
"provisionUser": true,
"sugarCustom": []
},
"idp": {
"entityId": "http://localhost:8080/simplesaml/saml2/idp/metadata.php",
"singleSignOnService": {
"url": "http://localhost:8080/simplesaml/saml2/idp/SSOService.php",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
},
"singleLogoutService": {
"url": "http://localhost:8080/simplesaml/saml2/idp/SingleLogoutService.php",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html |
8343803660c3-3 | },
"x509cert": "-----BEGIN CERTIFICATE-----\n --x509cert-- \n-----END CERTIFICATE-----"
},
"security": {
"authnRequestsSigned": false,
"logoutRequestSigned": false,
"logoutResponseSigned": false,
"signatureAlgorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256",
"validateRequestId": false
}
}
}
Change Log
Version
Change
v11_2
Added /Administration/settings/auth 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/Administrationsettingsauth_GET/index.html |
7ceccbcb7a56-0 | /Users/: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/Usersrecordlink_POST/index.html |
7ceccbcb7a56-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/Usersrecordlink_POST/index.html |
7ceccbcb7a56-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/Usersrecordlink_POST/index.html |
7ceccbcb7a56-3 | "email": [
{
"email_address": "[email protected]",
"opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "[email protected]",
"opt_out": "0",
"invalid_email": "0",
"primary_address": "1"
}
],
"phone_mobile": "(294) 447-9707",
"phone_work": "(036) 840-3216",
"phone_other": "",
"phone_fax": "",
"email1": "[email protected]",
"email2": "[email protected]",
"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/Usersrecordlink_POST/index.html |
7ceccbcb7a56-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/Usersrecordlink_POST/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.