id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
e3ca6369c2f9-3
|
"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": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-4
|
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-5
|
"name": "Gus Dales",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": false,
"assigned_user_id": "seed_sally_id",
"assigned_user_name": "Sally Bronsen",
"team_name": [
{
"id": "West",
"name": "West",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-6
|
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"salutation": "",
"first_name": "Gus",
"last_name": "Dales",
"full_name": "Gus Dales",
"title": "Director Operations",
"linkedin": "",
"facebook": "",
"twitter": "",
"googleplus": "",
"department": "",
"do_not_call": false,
"phone_home": "(661) 120-2292",
"email": [
{
"email_address": "[email protected]",
"opt_out": "1",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-7
|
"opt_out": "1",
"invalid_email": "0",
"primary_address": "0"
},
{
"email_address": "[email protected]",
"opt_out": "0",
"invalid_email": "0",
"primary_address": "1"
}
],
"phone_mobile": "(294) 447-9707",
"phone_work": "(036) 840-3216",
"phone_other": "",
"phone_fax": "",
"email1": "[email protected]",
"email2": "[email protected]",
"invalid_email": false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-8
|
"invalid_email": false,
"email_opt_out": false,
"primary_address_street": "48920 San Carlos Ave",
"primary_address_street_2": "",
"primary_address_street_3": "",
"primary_address_city": "Persistance",
"primary_address_state": "CA",
"primary_address_postalcode": "54556",
"primary_address_country": "USA",
"alt_address_street": "",
"alt_address_street_2": "",
"alt_address_street_3": "",
"alt_address_city": "",
"alt_address_state": "",
"alt_address_postalcode": "",
"alt_address_country": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-9
|
"alt_address_country": "",
"assistant": "",
"assistant_phone": "",
"picture": "",
"email_and_name1": "",
"lead_source": "Support Portal User Registration",
"account_name": "Arts & Crafts Inc",
"account_id": "d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields": "",
"opportunity_role_id": "",
"opportunity_role": "Technical Advisor",
"reports_to_id": "",
"report_to_name": "",
"portal_name": "GusDales145",
"portal_active": true,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-10
|
"portal_active": true,
"portal_password": "$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1": "",
"portal_app": "",
"preferred_language": "en_us",
"campaign_id": "",
"campaign_name": "",
"c_accept_status_fields": "",
"m_accept_status_fields": "",
"accept_status_id": "",
"accept_status_name": "",
"sync_contact": "",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-11
|
"fields": {
}
}
},
{
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-12
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-13
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-14
|
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_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/Teamsrecordlink_POST/index.html
|
9ef12406b520-0
|
/<module>/recent-product GET
Overview
Opportunity Recent Product Help
Summary
This endpoint retrieves top 10 recently used Quoted/Revenue Line Items based on the module to display them in the
"Product Catalog Quick Picks" dashlet in the reverse chronological order.
Request Arguments
None
Response Arguments
NONE
Response
{
"next_offset":-1,
"records":[
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-1
|
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-2
|
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-3
|
"Base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-4
|
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-5
|
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-6
|
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
"vendor_part_num":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-7
|
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-8
|
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-9
|
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-10
|
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"Base_rate":"1.000000"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-11
|
"Base_rate":"1.000000"
},
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-12
|
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
9ef12406b520-13
|
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/recent_product GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecent-product_GET/index.html
|
5e9e6c9476af-0
|
/pmse_Inbox/AdhocReassign/:data/:flowId GET
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxAdhocReassigndataflowId_GET/index.html
|
b381109ecb70-0
|
/oauth2/bwc/login POST
ATTENTION: FOR INTERNAL USAGE ONLY
This endpoint is subject to change.
Overview
Retrieves a cookie from the OAuth token.
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/oauth2bwclogin_POST/index.html
|
1630e777b022-0
|
/Calls/:record DELETE
Overview
Deletes either a single event record or a series of event records
Request Arguments
Name
Type
Description
Required
all_recurrences
Boolean
Flag to delete all events in a series.
False
Request
http://{site_url}/rest/v10/Meetings/2c9e5c09-6824-0d14-f5cb-5130321ac3cf?all_recurrences=true
Response Arguments
Name
Type
Description
id
String
Returns the ID of the deleted record.
Response
{
"id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9"
}
Change Log
Version
Change
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Callsrecord_DELETE/index.html
|
1630e777b022-1
|
}
Change Log
Version
Change
v10
Added /<module>/:record 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/Callsrecord_DELETE/index.html
|
58969cce10eb-0
|
/pmse_Inbox/AdhocReassign PUT
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxAdhocReassign_PUT/index.html
|
03ed476a39ab-0
|
/me/preferences PUT
Overview
Mass updates preferences for the user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preferences 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/mepreferences_PUT/index.html
|
2c4bc2201316-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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html
|
2c4bc2201316-1
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html
|
2c4bc2201316-2
|
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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html
|
2c4bc2201316-3
|
},
{
"_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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_name_GET/index.html
|
2c4bc2201316-4
|
}
],
"errors": {
"meetings": {
"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
|
c54a5e7d4e50-0
|
/EmbeddedFiles/:record/file/:field GET
Overview
Retrieves an attached file for a specific field on a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.
Response
Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding...
Change Log
Version
Change
v10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_GET/index.html
|
c54a5e7d4e50-1
|
Change Log
Version
Change
v10
Added /<module>/:record/file/: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/EmbeddedFilesrecordfilefield_GET/index.html
|
6c594577c424-0
|
/theme GET
Overview
Fetches the customizable variables of a theme.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
False
themeName
String
The theme name - /themes/clients/platform/***THEME NAME***/.
False
Request
http://{site_url}/rest/v10/theme?platform=base&themeName=default
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
mixins
Array
An array of name value pairs detailing mixin colors
hex
Array
A array of name value pairs detailing css colors
rgba
Array
An array of name value pairs detailing colors
rel
Array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/theme_GET/index.html
|
6c594577c424-1
|
rgba
Array
An array of name value pairs detailing colors
rel
Array
An array of name value pairs detailing relationships
bg
Array
An array of name value pairs detailing backgroup colors
Response
{
"colors":[
{
"name":"BorderColor",
"value":"#E61718"
},
{
"name":"NavigationBar",
"value":"#000000"
},
{
"name":"PrimaryButton",
"value":"#177EE5"
}
]
}
Change Log
Version
Change
v10
Added /<theme> 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/theme_GET/index.html
|
e22322d1dffd-0
|
/Notifications 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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-1
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-2
|
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. 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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-3
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-4
|
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
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-5
|
"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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-6
|
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
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-7
|
$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"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-8
|
{
"$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
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-9
|
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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-10
|
{
_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": [
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Notifications_GET/index.html
|
e22322d1dffd-11
|
"description":"",
"opportunities": [
{
_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/Notifications_GET/index.html
|
56442472d8bc-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
|
3db9fbf8266a-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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordcollectioncollection_namecount_GET/index.html
|
3db9fbf8266a-1
|
}
}
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
|
af19e605095f-0
|
/KBContents/config PUT
Creates and/or updates the config settings for the KBContents module
Summary:
This endpoint is used to create and/or update the config settings for the KBContents module as json data.
It extends the core config endpoint by adding the functionality to process deleted languages and documents
related to them.
Query Parameters:
Param
Description
Optional
Input Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
Output Example:
{
"languages":[{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsconfig_PUT/index.html
|
af19e605095f-1
|
}
Output Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
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/KBContentsconfig_PUT/index.html
|
26659c40140e-0
|
/mostactiveusers GET
Overview
Fetches the most active users for meetings, calls, inbound emails, and outbound emails.
Request Arguments
Name
Type
Description
Required
days
Integer
Returns most active users for the last specified quantity of days. Defaults to 30 days if not specified.
False
Request
http://{site_url}/rest/v10/mostactiveusers?days=30
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Response
{
"meetings":{
"user_id":"seed_sarah_id",
"count":"20",
"first_name":"Sarah",
"last_name":"Smith"
},
"calls":{
"user_id":"seed_will_id",
"count":"7",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mostactiveusers_GET/index.html
|
26659c40140e-1
|
"user_id":"seed_will_id",
"count":"7",
"first_name":"Will",
"last_name":"Westin"
},
"inbound_emails":{
"user_id":"seed_sarah_id",
"count":"20",
"first_name":"Sarah",
"last_name":"Smith"
},
"outbound_emails":{
"user_id":"seed_max_id",
"count":"17",
"first_name":"Max",
"last_name":"Jensen"
}
}
Change Log
Version
Change
v10
Added /mostactiveusers GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mostactiveusers_GET/index.html
|
f7f2e6d86ab9-0
|
/pmse_Inbox/settings GET
Overview
Retrieve settings for the PA engine
Summary
This endpoint gets settings for the SugarBPMTM engine
Request Arguments
Name
Type
Description
Required
fields
string
Comma separated list of SugarBPMTM config keys to return. If not sent, all config settings will be returned.
false
Response Arguments
Name
Type
Description
logger_level
string
Level of logging
error_number_of_cycles
integer
Error number of cycles
error_timeout
integer
Timeout for errors
Response
{
"logger_level":"critical",
"error_number_of_cycles":"10",
"error_timeout":"40"
}
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_Inboxsettings_GET/index.html
|
6185c5e77daa-0
|
/connector/twitter/:twitterId GET
Overview
Responds with twitter timeline if connector is set up in administration
Request Arguments
Name
Type
Description
Required
count
Integer
The number of tweets to retrieve.
False
Response Arguments
Name
Type
Description
<response>
String
Response
[
{
"created_at":"Tue Jun 25 23:45:35 +0000 2013",
"id":349674766946414592,
"id_str":"349674766946414592",
"text":"this tweet is awesome!",
"source":"web",
"truncated":false,
"in_reply_to_status_id":null,
"in_reply_to_status_id_str":null,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-1
|
"in_reply_to_status_id_str":null,
"in_reply_to_user_id":143456975,
"in_reply_to_user_id_str":"14934565",
"in_reply_to_screen_name":"testdesk",
"user":{
"id":2630841,
"id_str":"2630841",
"name":"SugarCRM",
"screen_name":"sugarcrm",
"location":"Cupertino, CA",
"description":"Everyone Sells. Everyone Supports. Everyone Connects.",
"url":"http:\/\/t.co\/s9ejrBSlki",
"entities":{
"url":{
"urls":[
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-2
|
"url":{
"urls":[
{
"url":"http:\/\/t.co\/s9ejrBSlki",
"expanded_url":"http:\/\/www.sugarcrm.com",
"display_url":"sugarcrm.com",
"indices":[
0,
22
]
}
]
},
"description":{
"urls":[
]
}
},
"protected":false,
"followers_count":8761,
"friends_count":6966,
"listed_count":453,
"created_at":"Wed Mar 28 07:16:58 +0000 2007",
"favourites_count":27,
"utc_offset":-28800,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-3
|
"utc_offset":-28800,
"time_zone":"Pacific Time (US \u0026 Canada)",
"geo_enabled":false,
"verified":false,
"statuses_count":7488,
"lang":"en",
"contributors_enabled":false,
"is_translator":false,
"profile_background_color":"98C7EA",
"profile_background_image_url":"http:\/\/a0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_image_url_https":"https:\/\/si0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_tile":false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-4
|
"profile_background_tile":false,
"profile_image_url":"http:\/\/a0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_image_url_https":"https:\/\/si0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_link_color":"0045AD",
"profile_sidebar_border_color":"FFFFFF",
"profile_sidebar_fill_color":"CCEAFF",
"profile_text_color":"000000",
"profile_use_background_image":true,
"default_profile":false,
"default_profile_image":false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-5
|
"default_profile":false,
"default_profile_image":false,
"following":null,
"follow_request_sent":false,
"notifications":null
},
"geo":null,
"coordinates":null,
"place":null,
"contributors":null,
"retweet_count":1,
"favorite_count":0,
"entities":{
"hashtags":[
],
"symbols":[
],
"urls":[
],
"user_mentions":[
{
"screen_name":"testdesk",
"name":"testdesk",
"id":143455,
"id_str":"ertrt75",
"indices":[
0,
8
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html
|
6185c5e77daa-6
|
"indices":[
0,
8
]
}
],
"media":[
]
},
"favorited":false,
"retweeted":false,
"possibly_sensitive":false,
"lang":"en"
}
]
Change Log
Version
Change
v10
Added /twitter/{twitterId} 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/connectortwittertwitterId_GET/index.html
|
ea8c23f041ef-0
|
/Opportunities/enum/:field GET
Overview
Retrieves the enum values for a specific field.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<list values>
Array
Returns the enum values for a field.
Response
{
"":"",
"Analyst":"Analyst",
"Competitor":"Competitor",
"Customer":"Customer",
"Integrator":"Integrator",
"Investor":"Investor",
"Partner":"Partner",
"Press":"Press",
"Prospect":"Prospect",
"Reseller":"Reseller",
"Other":"Other"
}
Change Log
Version
Change
v10
Added /<module>/enum/:field GET endpoint.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesenumfield_GET/index.html
|
ea8c23f041ef-1
|
Added /<module>/enum/:field GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesenumfield_GET/index.html
|
0798f143f5e3-0
|
/pmse_Project/CrmData/:record/:filter PUT
Overview
Updates information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will update various data related to the Process Definition
with the data provided in the request payload.
Request Arguments
Name
Type
Description
Required
record
String
The type of data to be updated
True
filter
String
Filtering criteria to be applied to data updated
False
Request
/rest/v11/pmse_Project/CrmData/clearEventCriteria/383414365573cf64b8eaa65039872849
Request Payload
{
"data":null
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
"success":true
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatarecordfilter_PUT/index.html
|
0798f143f5e3-1
|
The status of the update operation
Response
{
"success":true
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatarecordfilter_PUT/index.html
|
a09db366a45d-0
|
/me/preference/:preference_name POST
Overview
Creates a preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferencepreference_name_POST/index.html
|
957c36da3e7c-0
|
/ping GET
Overview
Responds with "pong" if the access_token is valid.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<response>
String
Returns pong is authenticated.
Response
pong
Change Log
Version
Change
v10
Added /ping 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/ping_GET/index.html
|
ec4105c149e0-0
|
/search GET
Overview
List records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.
Request Arguments
Name
Type
Description
Required
q
String
The search text to match records on. This will search through any fields on the module that has unified_search set to true.
False
max_num
Integer
A maximum number of records to return.
False
offset
Integer
The number of records to skip over before records are returned.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html
|
ec4105c149e0-1
|
Example: name,account_type,description
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
favorites
Boolean
Only fetch the current users favorited records.
False
my_items
Boolean
Only fetch items assigned to the current user.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html
|
ec4105c149e0-2
|
records
Array
An array of results containing matched records.
Response
{
"next_offset":2,
"records":[
{
"id":"ecbf2a6c-261e-5fca-fbb6-512d093554b8",
"name":"Avery Software Co",
"date_modified":"2013-02-26T19:12:56+00:00",
"description":"",
"my_favorite":false,
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_search":{
"score":1
}
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html
|
ec4105c149e0-3
|
"score":1
}
},
{
"id":"af5f8dae-7169-b497-1d77-512d0937ed81",
"name":"Avery Software Co",
"date_modified":"2013-02-26T19:12:56+00:00",
"description":"",
"my_favorite":false,
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_search":{
"score":1
}
}
]
}
Change Log
Version
Change
v10
Added /<module> GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/search_GET/index.html
|
5958072a68a3-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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackagesinstalled_GET/index.html
|
5958072a68a3-1
|
"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
|
86cb30aa9f14-0
|
/Emails/filter 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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-1
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-2
|
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
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-3
|
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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-4
|
$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/Emailsfilter_POST/index.html
|
86cb30aa9f14-5
|
$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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-6
|
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":[
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-7
|
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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-8
|
"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
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-9
|
"name_2":"",
"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]",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-10
|
"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.",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-11
|
"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":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-12
|
"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":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-13
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-14
|
"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
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-15
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-16
|
"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",
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-17
|
"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":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-18
|
"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",
"portal_password1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_POST/index.html
|
86cb30aa9f14-19
|
"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/Emailsfilter_POST/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.