id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
439d4789c370-2 | "value": "(212) 692-3480",
"event_type": "update",
"date_modified": "2018-02-21T19:56:42+00:00",
"source": {
"subject": {
"_type": "user",
"id": "654b3b50-16dc-11e8-9c03-a45e60e64465",
"_module": "Users",
"client": {
"_type": "rest-api"
},
"first_name": "Jim",
"last_name": "Conners",
"name": "Jim Conners"
},
"attributes": {
"platform": "base"
}
}
}
]
}
Change Log
Version
Change | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html |
439d4789c370-3 | }
}
]
}
Change Log
Version
Change
11.1
Added /pii GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordpii_GET/index.html |
339d18c8e08e-0 | /metadata/<module>/:segment GET
Overview
[ADMIN] Gets the desired segment for a given module.
Summary
Gets the desired segment for a given module. This is used only for modules that are not visible and thus not in metatdata for the given context. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any request arguments.
Response
{
"fields": {
Any fields associated with the module
}
}
Change Log
Version
Change
v11_11
Added /metadata/<module>/:segment 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/metadatamodulesegment_GET/index.html |
0bcfc74b4616-0 | /<module>/:record/link/activities 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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivities_GET/index.html |
0bcfc74b4616-1 | "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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkactivities_GET/index.html |
0bcfc74b4616-2 | "last_comment": { This will be the last comment on the post, which can be used to create a comment model on the frontend.
"deleted": 0,
"data": []
},
"fields": [],
"first_name": null,
"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/modulerecordlinkactivities_GET/index.html |
bb85bd560409-0 | /Administration/packages/:file_install/install GET
Overview
[ADMIN] PackageManager install a package.
Summary
Installs the specified package. Package 'file_install' hash must be provided. file_install hash could be found in staging package list.
Response
Returns http status 200 OK and newly installed 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/:file_install/install 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/Administrationpackagesfile_installinstall_GET/index.html |
f1780efa4cc7-0 | /CommentLog/:record GET
Overview
Retrieves a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
f1780efa4cc7-1 | "created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
f1780efa4cc7-2 | "name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019",
"billing_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
f1780efa4cc7-3 | "billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019",
"shipping_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
f1780efa4cc7-4 | "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":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
f1780efa4cc7-5 | ],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/CommentLogrecord_GET/index.html |
17397de029e5-0 | /Opportunities/: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"
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-1 | {
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-2 | "name":"New Account Name",
"date_entered":"2013-02-26T19:12:00+00:00",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-3 | {
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-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":"",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-5 | "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"
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
17397de029e5-6 | "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/Opportunitiesrecord_PUT/index.html |
29ca16dab17e-0 | /Administration/search/status GET
Overview
[ADMIN] Search status
Summary
This endpoint returns the status of the search backend including a list of the activated full text search modules.
This endpoint is only available to administrators.
Response
{
"available":true,
"enabled_modules":
[
"Accounts",
"Bugs",
"Calls",
"Campaigns",
]
}
Change Log
Version
Change
v10
Added /Administration/search/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/Administrationsearchstatus_GET/index.html |
93606141caee-0 | /me PUT
Overview
Returns the current user object.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Response User Example
{
"current_user":{
"type":"user",
"id":"1",
"full_name":"Administrator",
"timepref":"h:ia",
"timezone":"America/Los_Angles",
"user_name":"admin"
}
}
Response Portal User Example
{
"current_user":{
"type":"support_portal",
"id":"1234-567",
"user_id":"abcd-123",
"full_name":"Bill Williamson",
"timepref":"h:ia",
"timezone":"America/Denver", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_PUT/index.html |
93606141caee-1 | "timezone":"America/Denver",
"user_name":"SupportPortalApi"
}
}
Change Log
Version
Change
v10
Added /me PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_PUT/index.html |
d933ac78d490-0 | /Emails/filter GET
Overview
Lists filtered emails.
Summary
Adds additional operators to Filter API that are
specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails
involving the current user.
Filter By Sender
This will return all emails sent by the current user, by the contact whose ID is
fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address [email protected], which is referenced by
the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is
73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address [email protected], which is referenced by | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-1 | the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.
{
"filter": [{
"$from": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-2 | }, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
"email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-3 | }, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
"email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}
}]
}
Filter By Recipients
This would return all archived emails received by the current user.
{
"filter": [{
"$or": [{
"$to": [{
"parent_type": "Users", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-4 | "$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-5 | "$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Filter By Sender and Recipients
This would return all archived emails sent by a contact to the current user.
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-6 | This would return all archived emails sent by a contact to the current user.
{
"filter": [{
"$from": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}, {
"$or": [{
"$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}] | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-7 | "parent_id": "$current_user_id"
}]
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}
}, {
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
d933ac78d490-8 | }]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Change Log
Version
Change
v10
Added the $from, $to, $cc, and $bcc operators to
/Emails/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
05b0d8174eec-0 | /Dashboards/:id/restore-metadata PUT
Overview
Restores the metadata for a module's dashboard to the default metadata.
Summary
This endpoint is used to restore the default metadata for a module's dashboard.
Request Arguments
Name
Type
Description
Required
dashboard_module
string
The module dashboard belongs to (e.g. Home, Cases, Accounts)
True
dashboard
string
The dashboard name (e.g. portal-home)
True
Request
{
"dashboard_module":"Home",
"dashboard":"portal-home"
}
Â
Response Example
{
"id":"123",
"name":"LBL_PORTAL_HOME",
"dashboard_module": "Home",
"view_name": "home",
"metadata": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsidrestoremetadata_PUT/index.html |
05b0d8174eec-1 | "view_name": "home",
"metadata": {
"css_class": "portal-home-dashboard"
"components": {...},
},
...
}
Change Log
Version
Change
v11.13
Added /Dashboards/<id>/restore-metadata 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/Dashboardsidrestoremetadata_PUT/index.html |
45a56a068196-0 | /Users/:record/freebusy GET
Get a user's FreeBusy schedule
Summary:
This endpoint returns a list of time slots for which the specified person is busy.
Request
GET /Users/:id/freebusy
Response
{
"id": "foo"
"module": "Users",
"freebusy": [
{
"start": "2014-08-24T08:45:00-04:00",
"end": "2014-08-24T09:15:00-04:00"
},
{
"start": "2014-08-30T05:45:00-04:00",
"end": "2014-08-30T06:15:00-04:00"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordfreebusy_GET/index.html |
45a56a068196-1 | },
{
"start": "2014-09-12T15:45:00-04:00",
"end": "2014-09-12T16:15:00-04:00"
}
]
}
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/Usersrecordfreebusy_GET/index.html |
b74ba610688f-0 | /pmse_Project/validateCrmData/:data/:filter GET
Overview
Validates information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will validate the existence of various data related to the Process Definition.
Request Arguments
Name
Type
Description
Required
data
String
The type of data to be retrieved
True
filter
String
Filtering criteria to be applied to data retrieved
False
key
String
Key of the entry to search for within the given data and filter
True
Request
Note: "key" should be provided in the form of a URL query string.
Example Request:
/rest/v11_10/pmse_Project/validateCrmData/field/Accounts?key=data_entered
Response Arguments
Name
Type
Description
result
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectvalidateCrmDatadatafilter_GET/index.html |
b74ba610688f-1 | Response Arguments
Name
Type
Description
result
Boolean
The result of the validation. True if the key exists in the specified data set; false otherwise
Response
{
result: true
}
Change Log
Version
Change
v11_10
Added /pmse_Project/validateCrmData/:data/: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_ProjectvalidateCrmDatadatafilter_GET/index.html |
0b1df92bc4a0-0 | /Meetings/: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/Meetingsrecord_DELETE/index.html |
0b1df92bc4a0-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/Meetingsrecord_DELETE/index.html |
99bc856d6682-0 | /Calls POST
Overview
Create a single event or a series of event records.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Department Meeting",
"description":"Weekly Department Meeting",
"date_start":"yyyy-mm-ddThh:mm:ss-00:00",
"date_end":"yyyy-mm-ddThh:mm:ss-00:00",
"repeat_type":"Weekly",
"repeat_interval":"1", /* Every Week */
"repeat_dow":"25", /* Tue and Fri */
"repeat_count":"4", /* 4 Recurrences */ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calls_POST/index.html |
99bc856d6682-1 | "repeat_count":"4", /* 4 Recurrences */
"repeat_until":"",
}
Response Arguments
Name
Description
Start Date
End Date
<record field>
Returns the fields for the newly created record.
Response
{
}
Change Log
Version
Change
v10
Added /<module> 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/Calls_POST/index.html |
f9a5d2ee5d7b-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
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idprogressManageruser_id_GET/index.html |
f9a5d2ee5d7b-1 | 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 |
75170d2d256d-0 | /login/marketingContentUrl GET
Overview
Returns the SugarCRM marketing content URL that is managed by the marketing team.
Summary
This API attempts to reach SugarCRM's marketing content URL. If the service is unreachable, a URL for the static content is returned.
Request Arguments
Name
Type
Description
Required
selected_language
String
Code for the desired marketing content language. (Eg. "en_us", "fr_FR"). Providing a certain language code does not guarantee that content returned will be in the provided language. If an invalid language is specified, will assume "en_us".
False. It uses the configured language if this parameter is missing. Defaults to "en_us".
static
Boolean
If set to true, return URL for static marketing content. Defaults to false.
False. If this parameter is missing, the API defaults to the dynamic content url.
Response Arguments | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/loginmarketingContentUrl_GET/index.html |
75170d2d256d-1 | Response Arguments
Name
Type
Description
url
String
URL suitable for embedding in an iFrame that links to marketing content from SugarCRM.
Response
"https://www.sugarcrm.com/product-login-page-service/"
Change Log
Version
Change
v11_9
Added /login/marketingContentUrl 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/loginmarketingContentUrl_GET/index.html |
0329e9f94331-0 | /EmailAddresses POST
Overview
Create a new email address.
Summary
In the event that the email address already exists, that record will be returned without making any changes.
Request Arguments
Name
Type
Description
Required
email_address
String
The email address.
True
invalid_email
Boolean
true if the email address is invalid. false is the default.
False
opt_out
Boolean
true if the email address is opted out. false is the default.
False
Request
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": false
}
Response Arguments
Name
Type
Description
<record field> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html |
0329e9f94331-1 | }
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"date_created": "2016-02-25T11:53:07-08:00",
"date_modified": "2016-02-25T11:53:07-08:00",
"deleted": false,
"email_address": "[email protected]",
"email_address_caps": "[email protected]",
"invalid_email": false,
"opt_out": false,
"_acl": {
"fields": {}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html |
0329e9f94331-2 | "_acl": {
"fields": {}
},
"_module": "EmailAddresses"
}
Change Log
Version
Change
v10
Added /EmailAddresses POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmailAddresses_POST/index.html |
d4b2236f05ec-0 | /Forecasts/user/:user_id GET
ForecastsApi - user
Summary:
This endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id.
Query Parameters:
Param
Description
Optional
user_id
Returns user data for this specific user id
Â
Input Example:
{
user_id:seed_sally_id
}
Output Example:
{
first_name: "Sally"
full_name: "Sally Bronsen"
id: "seed_sally_id"
is_manager: false
last_name: "Bronsen"
user_name: "sally"
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsuseruser_id_GET/index.html |
d4b2236f05ec-1 | user_name: "sally"
}
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/Forecastsuseruser_id_GET/index.html |
cc895a3bf758-0 | /Emails/:record/link/:link_name/:remote_id 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/:link_name/: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_nameremote_id_POST/index.html |
d526800d57cf-0 | /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETE
Overview
Removes a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_name
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html |
d526800d57cf-1 | True
lhs_sync_key_field_name
String
The name of the LHS field that contains lhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
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_name
String
The name of the RHS field that contains rhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html |
d526800d57cf-2 | A unique ID for the RHS record identifying it in an external system
True
Request
/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value
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
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html |
d526800d57cf-3 | }
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value 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/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_DELETE/index.html |
ed709122004a-0 | /css GET
Overview
Runs LessPHP for a platform and a theme and outputs an array of css files. If not found the css files
will be compiled.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
No. (defaults to base)
themeName
String
The theme name - /themes/clients/platform/***THEMENAME***/.
No. (defaults to default)
Request
{
platform: 'portal',
themeName: 'default'
}
Response
{
url: [ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/css_GET/index.html |
ed709122004a-1 | themeName: 'default'
}
Response
{
url: [
'cache/themes/clients/base/default/bootstrap_97c9cf53841dbe471c20d169e3533763.css',
'cache/themes/clients/base/default/sugar_14c42516aad866b7f80cc896ce5c5406.css',
]
}
Change Log
Version
Change
v10
Added /<css> 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/css_GET/index.html |
806251566877-0 | /<module>/filter/count GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
806251566877-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/modulefiltercount_GET/index.html |
bbca3331e998-0 | /pmse_Inbox/unattendedCases GET
Overview
Retrieves the processes to show on Unattended Process view
Summary
This endpoint gets the list of unattended processes
Request Arguments
Name
Type
Description
Required
module_list
string
Identifier used to determine which field to filter against
true
q
string
Filter applied to a field to determine which processes to return
false
order_by
string
Sort definition to apply to the result
false
Response Arguments
Name
Type
Description
next_offset
integer
Next offset for more results
records
<field>:<value>
List of unattended process attributes
Response
{
"next_offset":"-1",
"records":
[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html |
bbca3331e998-1 | "records":
[
{
"id":"3922976c-284f-11e6-9f40-6c4008960436",
"assigned_user_id":"1",
"date_modified":"2016-06-01 23:18:59",
"date_entered":"2016-06-01T16:18:59-07:00",
"name":"ABC2",
"cas_id":"2",
"cas_title":"ABC2",
"cas_status":"IN PROGRESS",
"pro_title":"PD1",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_init_user":"1",
"cas_user_full_name":"Sarah Smith", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxunattendedCases_GET/index.html |
bbca3331e998-2 | "cas_user_full_name":"Sarah Smith",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
"prj_user_id_full_name":"Administrator",
"cas_sugar_object_id":"38beb03a-284f-11e6-b059-6c4008960436",
"cas_sugar_module":"Accounts",
"assigned_user_name":"Administrator"
}
]
}
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_InboxunattendedCases_GET/index.html |
9c7c5418969d-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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
9c7c5418969d-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/Filters_GET/index.html |
21898f181b1f-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 |
dd8c987185ff-0 | /<module>/audit/export GET
Overview
Returns a list of data changes for a specific module.
Request Arguments
Name
Type
Description
Required
module
String
The name of the module.
True
Query Parameters
Name
Type
Description
Required
max_num
Integer
A maximum number of Audit records to return. The default is 100 records.
False
offset
Integer
The number of records to skip over before records are returned. The default is 0.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html |
dd8c987185ff-1 | {
"next_offset":-1,
"records":[
{
"id":"b569e480-237a-5921-4382-512ff555fee7",
"parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Team ID:",
"data_type":"team_list",
"before_value_string":"East",
"after_value_string":"Will"
},
{
"id":"bc0bee72-8398-a0a6-d731-512ff5bfebc7", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html |
dd8c987185ff-2 | "parent_id":"ef1b40aa-5815-4f8d-e909-512d09617ac8",
"date_created":"03\/01\/2013 12:26am",
"created_by":"admin",
"field_name":"Teams",
"data_type":"id",
"before_value_string":"East, Global, West",
"after_value_string":"Jim, Will"
}
]
}
Change Log
Version
Change
v11_11
Added /<module>/audit/export GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleauditexport_GET/index.html |
ad3945408d79-0 | /Administration/elasticsearch/queue GET
Overview
[ADMIN] Elasticsearch queue statistics
Summary
This endpoint returns the queue statistics for the Elasticsearch backend. This endpoint is only available to
administrators.
Response
{
"total":2238,
"queued":{
"Cases":"250",
"KBDocuments":"5",
"Notes":"50",
"Quotes":"2",
"Accounts":"51",
"Contacts":"201",
"Leads":"201",
"Opportunities":"150",
"RevenueLineItems":"578",
"Bugs":"50",
"Contracts":"2",
"Manufacturers":"2",
"ProductCategories":"43",
"Tasks":"200",
"Calls":"50",
"Emails":"200", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchqueue_GET/index.html |
ad3945408d79-1 | "Calls":"50",
"Emails":"200",
"Meetings":"200",
"Products":"3"
}
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/queue 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/Administrationelasticsearchqueue_GET/index.html |
55f40296fa1a-0 | /Currencies GET
Returns a collection of Currency models
Summary:
This end point is used to return the Currencies defined in the application
Url Parameters:
Param
Description
Optional
Possible Errors
Error
Description
Url Example:
/rest/v10/Currencies
Output Example:
{
"next_offset": -1,
"records": [
{
"id": "-99",
"name": "US Dollars",
"symbol": "$",
"iso4217": "USD",
"conversion_rate": 1,
"status": "Active",
"_acl": {
"fields": {}
},
"_module": "Currencies"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Currencies_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.