id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
7ceccbcb7a56-5 | "created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:36:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
7ceccbcb7a56-6 | "_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10 (7.6.0)
Added support for additional relationship values.
v10 (7.1.5)
Added /<module>/:record/link POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlink_POST/index.html |
90e32bf5eb4a-0 | /lang/labels/dropdown PUT
Overview
Update display labels of dropdown items for dropdowns under different languages.
Summary
This endpoint is used to update display labels of dropdown items in dropdowns under different languages.
Request Arguments
Name
Type
Description
Required
name
string
The dropdown name.
True
labels
array
The new labels grouped by language keys.
True
Request
[
{
"type": "dropdown",
"dropdown": "ai_conv_score_classification_dropdown",
"labels": {
"de_DE": {
"not_likely": "Unwahrscheinlich",
"less_likely": "Weniger wahrscheinlich"
},
"ja_JP": {
"not_likely": "ããããããªã",
"less_likely": "å¯è½æ§ãä½ã"
}
}
}
]
Â
Response Example
[
{
"name": "ai_conv_score_classification_dropdown",
"labels": {
"de_DE": {
"not_likely": "Unwahrscheinlich",
"less_likely": "Weniger wahrscheinlich"
},
"ja_JP": {
"not_likely": "ããããããªã", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/langlabelsdropdown_PUT/index.html |
90e32bf5eb4a-1 | "less_likely": "å¯è½æ§ãä½ã"
}
}
},
{
"name": "account_type_dom",
"labels": {
"de_DE": {
"Analyst": "Analytiker",
"Competitor": "Wettbewerber"
},
"ja_JP": {
"Analyst": "ã¢ããªã¹ã",
"Competitor": "競åä»ç¤¾é¸æ"
}
}
}
]
Change Log
Version
Change
v11.13
Added /lang/labels/dropdown/ 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/langlabelsdropdown_PUT/index.html |
c2c8db909c25-0 | /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETE
Overview
Removes a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_value
String
A unique ID for the LHS record identifying it in an external system
True
link_name
String
A name for the link
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request
/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
"record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
"related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_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/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_DELETE/index.html |
88e054258c43-0 | /Administration/elasticsearch/refresh/status GET
Overview
[ADMIN] Elasticsearch index refresh interval status
Summary
This endpoint returns the current refresh_interval for every index managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": "1s",
"aabbcc_accountsonly": "1s",
"aabbcc_shared": "1s"
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/refresh/status 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/Administrationelasticsearchrefreshstatus_GET/index.html |
7e2f9a8417e3-0 | /<module>/:record/collection/:collection_name GET
Overview
Lists related records from multiple links at a time.
Summary
This endpoint will return a set of related records fetched from multiple links defined by :collection_name.
The records will be filtered, sorted and truncated to max_num as a single collection.
Collections may use a field mapping. For instance, the due_date of Tasks may be referred to as date_end.
In this case the alias (date_end) should be used in filter and order_by expressions instead of real field name.
Note that response data still contains the original fields for the module.
Request Arguments
Name
Type
Description
Required
fields
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
view
String
See Filter API.
False
max_num
Integer
See Filter API.
False
filter
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
order_by
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
offset
Map
Individual offset for each link which the collection consists of.
-1 (or any negative value) denotes that the link should be skipped.
If link offset is not specified, it defaults to 0.
False
Response Arguments
Name
Type
Description
next_offset
Map
The next offset to retrieve records. -1 will be returned for the given link when there are no more records.
records
Array
The record result set.
errors
Map | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html |
7e2f9a8417e3-1 | records
Array
The record result set.
errors
Map
Errors encountered while making requests for the individual links. These errors are returned for the client to consume, but do not affect the response status of the request.
Response
{
"next_offset": {
"calls": 1,
"meetings": -1,
"tasks": -1,
},
"records": [
{
"_module": "Calls",
"_link": "calls",
"id": "8703fbf3-0ffa-c288-8d2c-512f943ecdc3",
"name": "Discuss review process",
"date_end": "2014-02-26T19:12:00+00:00"
},
{
"_module": "Tasks",
"_link": "tasks",
"id": "e1c495cb-af17-1b37-dd66-512f934fe155",
"name": "Introduce all players",
"due_date": "2014-02-26T19:12:00+00:00"
},
{
"_module": "Tasks",
"_link": "tasks",
"id": "456b7848-9959-5a64-cd34-512d0938addd",
"name": "Follow-up on proposal",
"due_date": "2014-02-26T19:12:00+00:00"
}
],
"errors": {
"meetings": {
"code": 403,
"error": "not_authorized", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html |
7e2f9a8417e3-2 | "code": 403,
"error": "not_authorized",
"error_message": "You are not authorized to perform this action. Contact your administrator if you need access."
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/collection/:collection_name 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/modulerecordcollectioncollection_name_GET/index.html |
2cb1dd7b8b4d-0 | /Administration/packages/installed GET
Overview
[ADMIN] PackageManager lists installed packages.
Summary
Lists installed 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"
}
]
}
Change Log
Version
Change
v11.8
Added /Administration/packages/installed 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/Administrationpackagesinstalled_GET/index.html |
68982ef39299-0 | /<module>/:record PUT
Overview
Update a record of the specified type.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"New Account Name",
"phone_office":"(555) 888-5555",
"website":"www.newsite.com",
"meetings": {
{
"add": ["21e3385e-404f-b470-407e-54044e3d8024"],
"delete": ["21e3385e-404f-b470-407e-54044e3d8023"],
"create": [
{
"name": "Test Meeting"
}
]
}
}
Link fields
It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
delete
List
List of related records ID.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"id":"f222265a-b755-da89-0bc7-512d09b800b6",
"name":"New Account Name",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html |
68982ef39299-1 | "date_modified":"2013-02-27T22:49: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_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Hospitality",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"9 IBM Path",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Francisco",
"billing_address_state":"CA",
"billing_address_postalcode":"43635",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(555) 888-5555",
"phone_alternate":"",
"website":"www.newsite.com",
"ownership":"",
"employees":"",
"ticker_symbol":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_PUT/index.html |
68982ef39299-2 | "ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"9 IBM Path",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Francisco",
"shipping_address_state":"CA",
"shipping_address_postalcode":"43635",
"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",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
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/modulerecord_PUT/index.html |
793d2bfab9aa-0 | /pmse_Inbox/ReassignForm/: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_InboxReassignFormdataflowId_GET/index.html |
32dabcf84e90-0 | /<module>/:record/collection/:collection_name/count GET
Overview
Counts related records from multiple links at a time.
Summary
This endpoint will return count of records related by multiple links defined by :collection_name.
The records may be filtered.
Request Arguments
Name
Type
Description
Required
filter
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
Response Arguments
Name
Type
Description
record_count
Map
Count of related records.
Response
{
"record_count": {
"calls": 1,
"meetings": 2,
"tasks": 3
}
}
Change Log
Version
Change
v10
Added /<module>/:record/collection/:collection_name/count 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/modulerecordcollectioncollection_namecount_GET/index.html |
74f6f59880f5-0 | /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POST
Overview
Creates a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_value
String
A unique ID for the LHS record identifying it in an external system
True
link_name
String
A name for the link
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request
/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
"record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
"related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value 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/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_POST/index.html |
d85abe153009-0 | /<module>/enum/:field GET
Overview
Retrieves the enum values for a specific field.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<list values>
Array
Returns the enum values for a field.
Response
{
"":"",
"Analyst":"Analyst",
"Competitor":"Competitor",
"Customer":"Customer",
"Integrator":"Integrator",
"Investor":"Investor",
"Partner":"Partner",
"Press":"Press",
"Prospect":"Prospect",
"Reseller":"Reseller",
"Other":"Other"
}
Change Log
Version
Change
v10
Added /<module>/enum/:field GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleenumfield_GET/index.html |
b39a013ee391-0 | /pmse_Inbox/cancelCases PUT
Overview
Call methods to cancel a process
Summary
This endpoint cancels one or more processes.
Request Arguments
Name
Type
Description
Required
cas_id
array
Collection of process trigger sequence ids
true
Response Arguments
Name
Type
Description
success
boolean
Result of the cancel operation
Response
{
"success":true
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcancelCases_PUT/index.html |
c751dd636e2a-0 | /ForecastWorksheets/filter POST
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
{
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
c751dd636e2a-1 | "date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
ab0389d8ddb1-0 | /Emails/:record/link/:link_name/add_record_list/:remote_id POST
Overview
Creates relationships to a pre-existing email from a record list.
Summary
Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records
as a sender (link: from) or recipients(links: to, cc, bcc). All other operations
described in Relate Record API are supported.
Change Log
Version
Change
v10
Added /Emails/:record/link/:link_name/add_record_list/:remote_id 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/Emailsrecordlinklink_nameadd_record_listremote_id_POST/index.html |
4e43aad479a9-0 | /Reports/:record/records GET
Overview
An API to deliver filtered records from a saved report.
Summary
This endpoint will return a list of records from a saved report filtered by an expression.
Request Arguments
Name
Type
Description
Required
group_filters
String
The group 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: group_filters[0][name]=value.
By specifying the whole filter as a single JSON-encoded string.
Example: group_filters=[{"name":"value"}].
Example: group_filters[0][industry]=Engineering.
False
use_saved_filters
Boolean
Flag to indicate whether or not to apply saved runtime filters if exists. The default value is false.
Example: use_saved_filters=true.
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
Request Example
GET /rest/v10/Reports/:id/records?group_filters[0][industry]=Engineering&use_saved_filters=true&offset=0&max_num=20
Response Arguments
Name
Type
Description
records
Array
An array of results containing matched records.
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordrecords_GET/index.html |
4e43aad479a9-1 | records.
Response
{
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"_acl": {
"fields": {
}
}
}
],
"next_offset": -1
}
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/Reportsrecordrecords_GET/index.html |
298856446166-0 | /pmse_Emails_Templates/:record/etemplate GET
Overview
Exports a .pet file with a Process Email Templates definition
Summary
This endpoint will retrieve a .pet file containing JSON encoded data of a
Process Email Templates definition identified by the record input
parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Email Template record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a MIME type application/pet file attachment without any response parameters.
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_Templatesrecordetemplate_GET/index.html |
1fda1364f1c0-0 | /RevenueLineItems/:record/quote POST
Convert a Revenue Line Item to a quote.
Summary:
This endpoint is used to convert a single RevenueLineItem to a quote
Query Parameters:
Param
Description
Optional
record
Which Revenue Line Item to convert
false
Valid Urls:
/rest/v10/RevenueLineItems/:record/quote/
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/RevenueLineItemsrecordquote_POST/index.html |
f3edf29d0082-0 | /pmse_Inbox/getLog GET
Overview
Return the text of the PMSE.log file
Summary
This endpoint gets the contents of the PMSE.log file
Request Arguments
There are no request arguments for this endpoint
Response Arguments
Name
Type
Description
none
string
Log Entries from PMSE.log
Response
"Test Log Entry1\nTest Log Entry2\n"
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_InboxgetLog_GET/index.html |
8afcbe06c190-0 | /pmse_Project GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
8afcbe06c190-1 | False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
8afcbe06c190-2 | False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
8afcbe06c190-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
8afcbe06c190-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
8afcbe06c190-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Project_GET/index.html |
d3be89b294c4-0 | /oauth2/logout POST
Overview
Expires the token portion of the OAuth 2.0 specification.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
success
Boolean
The success of the logout.
Response
{
"success":true
}
Change Log
Version
Change
v10
Added /oauth2/logout 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/oauth2logout_POST/index.html |
90e06c56e33f-0 | /Mail/address/validate POST
Overview
Validate one or more email addresses.
Request Arguments
Type
Description
Required
Array
Array of one or more email addresses to validate.
True
Request
[
"[email protected]",
"[email protected]",
"invalid-email.com"
]
Response Arguments
Type
Description
Object
Returns an object with each email address as a key and a boolean
indicating whether the email address is valid as the value.
Response
{
"[email protected]": true,
"[email protected]": true,
"invalid-email.com": false
}
Change Log
Version
Change
v11
Last version in which /Mail/address/validate POST is available.
v10
Added /Mail/address/validate 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/Mailaddressvalidate_POST/index.html |
0794be90dae0-0 | /<module>/config POST
Overview
Retrieves the config settings for a given module.
Summary
This endpoint is normally used to manage the forecasting module.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
Added /<module>/config 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/moduleconfig_POST/index.html |
504e68226326-0 | /pmse_Emails_Templates GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
504e68226326-1 | False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
504e68226326-2 | False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
504e68226326-3 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
504e68226326-4 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
504e68226326-5 | {
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templates_GET/index.html |
253c34b0f050-0 | /EmbeddedFiles/:record/file/:field POST
Overview
Attaches a file to a field on a record.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
delete_if_fails
Boolean
Indicates whether the API is to mark related record deleted if the file upload fails.
False
oauth_token
String
The oauth_token value.
False - Required if only if delete_if_fails is true.
<attachment field>
String
The field and file to populate.
Example: {"":"@\/path\/to\/ExampleDocument.txt"}
True
Request
{
"format":"sugar-html-json",
"delete_if_fails":true,
"oauth_token":"43b6b327-cc70-c301-3299-512ffb99ad97",
"<attachment field>":"@\/path\/to\/ExampleDocument.txt"
}
Response Arguments
Name
Type
Description
content-type
String
The files content type.
content-length
Integer
The files content length.
name
String
The files name.
uri
String
The URI of the file.
Response
{
"content-type":"text\/plain",
"content-length":16,
"name":"ExampleDocument.txt", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_POST/index.html |
253c34b0f050-1 | "content-length":16,
"name":"ExampleDocument.txt",
"uri":"http:\/\/sugarcrm\/rest\/v10\/Notes\/ca66c92f-5a8b-28b4-4fc8-512d099b790b\/file\/<attachment field>?format=sugar-html-json&delete_if_fails=1&oauth_token=6ec91cf3-1f97-25b9-e0b1-512f8971b2d4"
}
Change Log
Version
Change
v10
Added /<module>/:record/file/:field 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/EmbeddedFilesrecordfilefield_POST/index.html |
554f8cce2d1f-0 | /password/request GET
Overview
Sends an email request to reset a users password.
Request Arguments
Name
Type
Description
Required
email
String
The email of the user.
True
username
String
The username of the user.
True
Request
http://{site_url}/rest/v10/password/request?email=admin%40sugar.crm&username=admin
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
Success
boolean
Returns the result of sending the email.
Response
true
Change Log
Version
Change
v10
Added /password/request 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/passwordrequest_GET/index.html |
19c3e1c51e4c-0 | /<module>/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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
19c3e1c51e4c-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/modulefiltercount_POST/index.html |
75b966ba6a7a-0 | /integrate/<module>/:sync_key_field_name/:sync_key_field_value GET
Overview
Retrieves the record with the given sync_key_field_name.
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
Body: formatted JSON object.
Response
Successful Response
Status 200
Failed Response
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :sync_key_field_name::sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/:sync_key_field_value 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/Integratemodulesync_key_field_namesync_key_field_value_GET/index.html |
dc531bc06ff7-0 | /Administration/aws POST
Overview
[ADMIN] Set Amazon Web Services configs in Sugar Serve.
Summary
This endpoint sets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.
Request Arguments
Name
Type
Description
Required
aws_connect_instance_name
String
The name of the AWS Connect instance
False
aws_connect_region
String
The region assigned to the AWS Connect instance
False
Response
{
"aws_connect_instance_name": "my-aws-instance",
"aws_connect_region": "us-east-2"
}
Change Log
Version
Change
v11_10
Added /Administration/aws 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/Administrationaws_POST/index.html |
cf80caae79b5-0 | /Filters 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/Filters_GET/index.html |
cf80caae79b5-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/Filters_GET/index.html |
cf80caae79b5-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/Filters_GET/index.html |
cf80caae79b5-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/Filters_GET/index.html |
cf80caae79b5-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/Filters_GET/index.html |
cf80caae79b5-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/Filters_GET/index.html |
763a393ebf32-0 | /ForecastWorksheets/filter GET
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
{
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
763a393ebf32-1 | "date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_GET/index.html |
0f85427e5443-0 | /<module>/:record/link/activities/filter GET
Activities on a module's list view
Summary:
This endpoint lists activities across a particular module in the system. It does not use a subscription model unlike the other endpoints. It can be queried as a regular 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": []
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivitiesfilter_GET/index.html |
0f85427e5443-1 | "deleted": 0,
"data": []
},
"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/modulerecordlinkactivitiesfilter_GET/index.html |
7a8abba2bcb5-0 | /Forecasts/:timeperiod_id/progressManager/:user_id GET
Projected Manager Data
Summary:
This endpoint is used to return the json Data not already in client view for the Forecasts manager projected panel.
Query Parameters:
Param
Description
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
Input Example:
{
user_id:seed_sally_id
timeperiod_id:36f7085a-5889-ea75-84c8-50f42bd1a5ba
}
Output Example:
{
closed_amount: 0
opportunities: 13
pipeline_revenue: 470000
quota_amount: 382000.000000
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idprogressManageruser_id_GET/index.html |
6521019b5c28-0 | /<module>/customfield/:field DELETE
Overview
Delete a custom field for a specified module.
Summary
This endpoint is used to delete a custom field for a specified module.
Request Arguments
This endpoint does not accept any request arguments.
Response
{
"name": "ai_conv_score_c"
}
Response Codes and Error Messages
All successful responses should return 200.
This API returns the following error responses:
403 (SugarAPIExceptionNotAuthorized): Sent if the user attempts to access a module which they are forbidden to access.
404 (SugarApiExceptionNot Found): Sent if the requested field is not found.
422 (SugarApiExceptionInvalidParameter): Sent if the module and/or field are invalid.
500 (SugarApiExceptionError): Sent if there's an unknown error that causes the custom field to not be deleted in the module.
Change Log
Version
Change
v11.11
Added /<module>/customfield/:field 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/modulecustomfieldfield_DELETE/index.html |
e5b6b9850916-0 | /<module>/:root/tree GET
Overview
Retrieves full tree for selected root 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
{
"next_offset": -1,
"records": [{
"id": "ad4ddf76-327a-11e4-818b-5404a67f3363",
"name": "Documents",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "2",
"rgt": "9",
"level": "1",
"children": {
"next_offset": -1,
"records": [{
"id": "ad4e03f1-327a-11e4-818b-5404a67f3363",
"name": "Engeneering",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
e5b6b9850916-1 | "description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "3",
"rgt": "4",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, {
"id": "f482dd1b-327a-11e4-818b-5404a67f3363",
"name": "Testing",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "5",
"rgt": "6",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, {
"id": "f482fb7a-327a-11e4-818b-5404a67f3363",
"name": "Management",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
e5b6b9850916-2 | "created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "7",
"rgt": "8",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}, {
"id": "045c03b9-327b-11e4-818b-5404a67f3363",
"name": "Audit",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "10",
"rgt": "19",
"level": "1",
"children": {
"next_offset": -1,
"records": [{
"id": "045c1de6-327b-11e4-818b-5404a67f3363",
"name": "Financial",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
e5b6b9850916-3 | "modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "11",
"rgt": "14",
"level": "2",
"children": {
"next_offset": -1,
"records": [{
"id": "0f658847-327b-11e4-818b-5404a67f3363",
"name": "Invoices",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "12",
"rgt": "13",
"level": "3",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}, {
"id": "0f65a6c7-327b-11e4-818b-5404a67f3363",
"name": "Agreements",
"date_entered": null,
"date_modified": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
e5b6b9850916-4 | "date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "15",
"rgt": "16",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, {
"id": "14d30bf3-327b-11e4-818b-5404a67f3363",
"name": "Clients",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "17",
"rgt": "18",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}]
}
Change Log
Version
Change
v10
Added /<module>/:record/tree GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
e5b6b9850916-5 | Added /<module>/:record/tree 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/moduleroottree_GET/index.html |
8cc7609c2af2-0 | /Administration/packages POST
Overview
[ADMIN] PackageManager upload package.
Summary
Uploads a module loadable package via a multi-part form request. The only parameter is 'upgrade_zip' which must contain a valid module loadable zip file.
Sample Request
POST /rest/v11_1/Administration/packages HTTP/1.1
Host: null
Content-Type: multipart/form-data
Accept: application/json
OAuth-Token: 3bbd6227-cfd0-45c7-8a6e-3c737e3c73ff
Content-Type: multipart/form-data; boundary=---------------------------9051914041544843365972754266
Content-Length: 554
-----------------------------9051914041544843365972754266
Content-Disposition: form-data; name="upgrade_zip"; filename="module.zip"
Content-Type: application/zip
{content-data}
-----------------------------9051914041544843365972754266--
Response
Returns status 200 OK and file hashes for install and delete package if request is successful.
{
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392"
}
Otherwise returns status 4xx with errors.
{
"error": "upload_package_error",
"error_message": "Issue with the manifest",
"error_description": "The uploaded file is not compatible with this version of Sugar: 11.3.0"
}
Change Log
Version
Change
v11.8
Added /Administration/packages 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/Administrationpackages_POST/index.html |
d00f7a40de91-0 | /integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETE
Overview
Deletes the record with the given sync_key_field_name.
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 deleted.
Response
Status 200
{ "id": "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:sync_key_field_name/: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/Integratemodulesync_key_field_namesync_key_field_value_DELETE/index.html |
b9d360531d30-0 | /ForecastManagerWorksheets/filter GET
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_GET/index.html |
b9d360531d30-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_GET/index.html |
661f63acc9eb-0 | /Administration/search/reindex POST
Overview
[ADMIN] Search schedule reindex
Summary
This endpoint schedules a reindex. This endpoint is only available to administrators.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to be reindexed. If omitted, all search enabled modules will be reindexed.
Example: Accounts,Contacts
False
clear_data
Boolean
If set the records of the selected modules will be removed from the search backend and the schema will be
recreated. All records from given modules will be queued to be reindexed which is orchestrated by the job
queue.
If not set, nothing is dropped from the search backend and all records of the selected modules are queued
for reindexing. This is the default behavior.
Example: Accounts,Contacts
False
Response
{
"success": true
}
Change Log
Version
Change
v10
Added /Administration/search/reindex 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/Administrationsearchreindex_POST/index.html |
bd9b87d289ba-0 | /<module>/:record/unsubscribe DELETE
Summary:
This endpoint deletes a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be unsubscribe from activity stream messages for the record being subscribed to, or "followed".
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.
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/modulerecordunsubscribe_DELETE/index.html |
552ca228ef1b-0 | /pmse_Inbox/note_list/:cas_id GET
Overview
Returns the notes list for a process
Summary
This endpoint gets the notes for a process
Request Arguments
Name
Type
Description
Required
cas_id
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
rowList
object
Note records
totalRows
integer
Total notes
currentOffset
integer
Current offset
currentDate
integer
Current date
Response
{
"rowList":
[
{
"pmse_bpm_notes__date_entered":"2016-06-02 16:52:21",
"id":"602d4cb0-28e2-11e6-88c9-6c4008960436",
"date_entered":"2016-06-02T09:52:21-07:00",
"date_modified":"2016-06-02T09:52:21-07:00",
"cas_id":"2",
"cas_index":"1",
"not_user_id":"1",
"not_user_recipient_id":"",
"not_type":"GENERAL",
"not_date":null,
"not_status":"ACTIVE",
"not_availability":"",
"not_content":"Test Note1",
"not_recipients":"",
"first_name":null,
"last_name":"Administrator",
"picture":"0b2dc2f0-2377-11e6-9d2a-6c4008960436"
}
],
"totalRows":1,
"currentOffset":0,
"currentDate":"2016-06-02 16:52:39"
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxnote_listcas_id_GET/index.html |
552ca228ef1b-1 | }
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_Inboxnote_listcas_id_GET/index.html |
e53e43a49090-0 | /Emails/:record/link POST
Overview
Creates a relationship to a pre-existing email.
Summary
Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records
as a sender (link: from) or recipients(links: to, cc, bcc). All other operations
described in Relate Record API are supported.
Change Log
Version
Change
v10
Added /Emails/:record/link POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlink_POST/index.html |
c28772ff5f7d-0 | /KBContents/filter 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/KBContentsfilter_GET/index.html |
c28772ff5f7d-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/KBContentsfilter_GET/index.html |
c28772ff5f7d-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/KBContentsfilter_GET/index.html |
c28772ff5f7d-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/KBContentsfilter_GET/index.html |
c28772ff5f7d-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/KBContentsfilter_GET/index.html |
c28772ff5f7d-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/KBContentsfilter_GET/index.html |
d1248eb6c3a2-0 | /<module>/:record/link/:link_name/filter/leancount GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
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
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. This argument
can be combined with the view argument.
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-1 | 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
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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-2 | $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/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-3 | ]
}
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.
Repsonse
{
"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",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-4 | "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",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-5 | "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",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-6 | "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"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-7 | ],
"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":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
d1248eb6c3a2-8 | "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/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/modulerecordlinklink_namefilterleancount_GET/index.html |
955186d1d635-0 | /Administration/elasticsearch/refresh/enable POST
Overview
[ADMIN] Elasticsearch enable refresh_interval
Summary
Enable refresh_interval for all indices managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/refresh/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/Administrationelasticsearchrefreshenable_POST/index.html |
e873490a5f07-0 | /Administration/packages/:id/enable GET
Overview
[ADMIN] PackageManager enable a package.
Summary
Enable the specified package. Package id hash must be provided. Package id could be found in installed package list.
Response
Returns http status 200 OK and enabled package ID if request is successful.
{
"id": "56365210-4cce-11ea-a7bf-acde48001122"
}
Otherwise returns http status 4xx with errors.
{
"error": "not_found",
"error_message": "Could not find package by ID."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:id/enable 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/Administrationpackagesidenable_GET/index.html |
e0327e1b2927-0 | /pmse_Inbox/reactivateFlows 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_InboxreactivateFlows_PUT/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.