id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
0e0ab4306a84-8 | "account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_DELETE/index.html |
0e0ab4306a84-9 | "preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id 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/modulerecordlinklink_nameremote_id_DELETE/index.html |
f380c41c8326-0 | /Mail/attachment/:file_guid DELETE
Overview
Delete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with a bool of true.
Change Log
Version
Change
v11
Last version in which /Mail/attachment/:file_guid DELETE is available. Use
/Notes/:id/file/filename DELETE to delete a file from the filesystem. Use
/Emails/:record/link/attachments/:remote_id DELETE to remove an attachment from an
email. Note that removing an attachment from an email will also delete it from the filesystem. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachmentfile_guid_DELETE/index.html |
f380c41c8326-1 | v10
Added /Mail/attachment/:file_guid DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailattachmentfile_guid_DELETE/index.html |
9b6ddd55e788-0 | /<module>/record_list/:record_list_id GET
Overview
An API to return record list data
Summary
Get record list data. Only GET request allowed.
Request Arguments
Name
Type
Description
Required
module
string
Module name
True
record_list_id
guid
record list id
True
Request Example
GET /rest/v10/:module/record_list/:id
Response Arguments
Name
Type
Description
id
guid
record list id
assigned_user_id
guid
user id
module_name
string
Module name
records
array
record ids
date modified
date
date modified
Output Example
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_GET/index.html |
9b6ddd55e788-1 | date modified
date
date modified
Output Example
{
"id": "39d2c781-c0b7-446f-1d83-56c6e3cda510",
"assigned_user_id": "1",
"module_name": "Accounts",
"records": [
"e5c8bb3b-5eea-3d8a-c278-56c6affa6212",
"e49395b4-d3b0-1e3f-600a-56c6afe7e34f",
"c03ed8ee-60d3-c6a6-55c3-56c6af95e696", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_GET/index.html |
9b6ddd55e788-2 | "d65573e3-c25a-f9b4-33f2-56c6afb8d856"
],
"date_modified": "2016-02-19 09:42:44"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_listrecord_list_id_GET/index.html |
aff91c0efabb-0 | /Mail/recipients/lookup POST
Overview
Accepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive
data for the recipient(s).
Request
[
{
"module": "Contacts",
"id": "962cefa8-2f1f-11e6-9ade-80e6500b09a0",
"email": "",
"name": ""
},
{
"module": "Leads",
"id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"email": "",
"name": "Vince Tallion"
}
]
Response
[
{
"module": "Contacts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientslookup_POST/index.html |
aff91c0efabb-1 | ]
Response
[
{
"module": "Contacts",
"id": "962cefa8-2f1f-11e6-9ade-80e6500b09a0",
"email": "[email protected]",
"name": "Kelly Germaine",
"resolved": true
},
{
"module": "Leads",
"id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"email": "[email protected]",
"name": "Vince Tallion",
"resolved": true
}
]
Change Log
Version
Change
v11
Last version in which /Mail/recipients/lookup POST is available. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientslookup_POST/index.html |
aff91c0efabb-2 | v10
Added /Mail/recipients/lookup 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/Mailrecipientslookup_POST/index.html |
d4daa51597ad-0 | /Mail/attachment/cache DELETE
Overview
Clears the user's attachment cache directory
Query Parameters:
This endpoint does not accept any parameters.
Input Example:
This endpoint does not accept any input.
Output Example:
If successful, the endpoint responds with a bool of true.
Change Log
Version
Change
v11
Last version in which /Mail/attachment/cache DELETE is available. Attachments are no longer
written as temporary files to the current user's cache directory.
v10
Added /Mail/attachment/cache 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/Mailattachmentcache_DELETE/index.html |
e2e37ace8fde-0 | /TimePeriods 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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
e2e37ace8fde-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/TimePeriods_GET/index.html |
af01a26bb3a4-0 | /Forecasts/:timeperiod_id/quotas/direct/:user_id GET
ForecastsQuotasApi - Get
Summary:
This endpoint is used to return quota information for a specific user ID, in a specific timeperiod and by a specifc type..
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Required
quota_type
"rollup" or "direct" quota
Required
user_id
Show for a specific user
Required
Input Example:
Output Example:
{
"currency_id":"-99",
"amount":"75.000000",
"date_modified":"2013-09-17 21:23:32",
"formatted_amount":"$75.00",
"is_top_level_manager":true
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idquotasdirectuser_id_GET/index.html |
af01a26bb3a4-1 | "is_top_level_manager":true
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idquotasdirectuser_id_GET/index.html |
424ef66e404c-0 | /pmse_Business_Rules/:record/brules GET
Overview
Exports a .pbr file with a Process Business Rules definition
Summary
This endpoint will retrieve a .pbr file containing JSON encoded data of a
Process Business Rules definition identified by the record input
parameter.
Request Arguments
Name
Type
Description
Required
record
String
The Process Business Rule record ID
True
Response Arguments
Name
Type
Description
N/A
Response
Note: The response is a MIME type application/pbr file attachment without any response parameters.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Business_Rulesrecordbrules_GET/index.html |
6b3e5b8628b3-0 | /ForecastWorksheets/export GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
6b3e5b8628b3-1 | }
Exporting Records by a List of IDs
{
"uid":[
"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"b3e87a3f-cd8f-7b86-467a-512d09e8d240"
]
}
Exporting Records Using a Filter
{
"filter":[
{
"name":"airline"
}
]
}
Exporting a Sample Result Set
{
"sample":true
}
Response Arguments
Name
Type
Description
<csv export>
String
Returns the selected records in CSV format with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
6b3e5b8628b3-2 | Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17
X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
6b3e5b8628b3-3 | Content-Type: application/octet-stream; charset=UTF-8
"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
6b3e5b8628b3-4 | "Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""
Change Log
Version
Change
v10
Added /<module>/export GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsexport_GET/index.html |
7331db3c8942-0 | /me/password POST
Overview
Create a new record of a specified type.
Summary
This endpoint allows for verification of the user's password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User
Request Arguments
Name
Type
Description
Required
password_to_verify
String
The password to verify
True
Request
{
"password_to_verify":"mycurrentpassword"
}
Response Arguments
Name
Type
Description
valid
Boolean
Returns the success of the password verification.
Response
{
"valid":true
}
Change Log
Version
Change
v10
Added /me/password POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_POST/index.html |
7331db3c8942-1 | Change
v10
Added /me/password 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/mepassword_POST/index.html |
a71df8d93188-0 | /<module>/:root/tree GET
Overview
Retrieves full tree for selected root record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
{
"next_offset": -1,
"records": [{
"id": "ad4ddf76-327a-11e4-818b-5404a67f3363",
"name": "Documents",
"date_entered": null,
"date_modified": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-1 | "date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "2",
"rgt": "9",
"level": "1",
"children": {
"next_offset": -1,
"records": [{
"id": "ad4e03f1-327a-11e4-818b-5404a67f3363", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-2 | "name": "Engeneering",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "3",
"rgt": "4",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-3 | "records": []
}
}, {
"id": "f482dd1b-327a-11e4-818b-5404a67f3363",
"name": "Testing",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "5",
"rgt": "6",
"level": "2",
"children": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-4 | "level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, {
"id": "f482fb7a-327a-11e4-818b-5404a67f3363",
"name": "Management",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "7", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-5 | "lft": "7",
"rgt": "8",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}, {
"id": "045c03b9-327b-11e4-818b-5404a67f3363",
"name": "Audit",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-6 | "source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "10",
"rgt": "19",
"level": "1",
"children": {
"next_offset": -1,
"records": [{
"id": "045c1de6-327b-11e4-818b-5404a67f3363",
"name": "Financial",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-7 | "description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "11",
"rgt": "14",
"level": "2",
"children": {
"next_offset": -1,
"records": [{
"id": "0f658847-327b-11e4-818b-5404a67f3363",
"name": "Invoices",
"date_entered": null,
"date_modified": null,
"modified_user_id": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-8 | "date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "12",
"rgt": "13",
"level": "3",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}, {
"id": "0f65a6c7-327b-11e4-818b-5404a67f3363", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-9 | "name": "Agreements",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "15",
"rgt": "16",
"level": "2",
"children": {
"next_offset": -1,
"records": []
}
}, { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-10 | "records": []
}
}, {
"id": "14d30bf3-327b-11e4-818b-5404a67f3363",
"name": "Clients",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "17",
"rgt": "18",
"level": "2",
"children": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
a71df8d93188-11 | "level": "2",
"children": {
"next_offset": -1,
"records": []
}
}]
}
}]
}
Change Log
Version
Change
v10
Added /<module>/:record/tree GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleroottree_GET/index.html |
b3c8e6f1119a-0 | /Emails 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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
b3c8e6f1119a-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/Emails_GET/index.html |
cd24ba2173de-0 | /Users/:record/link/:link_name/:remote_id DELETE
Overview
Deletes an existing relationship between two records.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record to disassociate from the related record.
related_record
Array
The record that was disassociated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
"name":"Slender Broadband Inc - 1000 units",
"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/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-1 | "date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-2 | },
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-3 | "date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"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/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-4 | "date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-5 | "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",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-6 | "opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-7 | "primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-8 | "account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_DELETE/index.html |
cd24ba2173de-9 | "preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/:remote_id 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/Usersrecordlinklink_nameremote_id_DELETE/index.html |
630ea4a1a90e-0 | /Emails/count GET
Overview
Lists filtered emails.
Summary
Adds additional operators to Filter API that are
specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails
involving the current user.
Filter By Sender
This will return all emails sent by the current user, by the contact whose ID is
fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address [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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
630ea4a1a90e-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/Emailscount_GET/index.html |
290da4a8eb6e-0 | /ForecastManagerWorksheets/filter GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return selective ManagerWorksheets with the optional filter parameter.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastManagerWorksheets/filter
{
"filter":[
{"assigned_user_id" : "seed_jim_id"}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html |
290da4a8eb6e-1 | {"assigned_user_id" : "seed_jim_id"},
{"timeperiod_id":"e546185a-5889-ea75-84c8-511178d1a5ba"}
],
}
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html |
290da4a8eb6e-2 | "modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html |
290da4a8eb6e-3 | "account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html |
290da4a8eb6e-4 | "fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_GET/index.html |
ce84ab4e93fe-0 | /<module>/temp/file/:field POST
Overview
Saves an image to a temporary folder.
Request Arguments
Name
Type
Description
Required
format
String
The data format. Currently accepts 'sugar-html-json'.
True
delete_if_fails
Boolean
Indicates whether the API is to mark related record deleted if the file upload fails.
False
oauth_token
String
The oauth_token value.
False - Required if only if delete_if_fails is true.
<image field>
String
The field and file to populate.
Example: {"":"@\/path\/to\/ExampleImage.png"}
True | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefield_POST/index.html |
ce84ab4e93fe-1 | True
Request
{
"format":"sugar-html-json",
"delete_if_fails":true,
"oauth_token":"8d240d9d-04ea-571b-35ea-513037ed5857",
"<image field>":"@\/path\/to\/\/ExampleImage.png"
}
Response Arguments
Name
Type
Description
guid
String
The temp ID of the image.
Response
{
"picture":{
"guid":"50a8760d-966f-9d7e-f45c-513037fac8fc"
}
}
Change Log
Version
Change
v10
Added /<module>/temp/file/:field POST endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefield_POST/index.html |
ce84ab4e93fe-2 | Added /<module>/temp/file/:field POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefield_POST/index.html |
1777d22ad9b5-0 | /KBContents/:record/notuseful PUT
Overview
Vote for Knowledge Base article.
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 updated record.
Response
{
"active_date": "2014-01-01",
"active_rev": 1,
"approved": false,
"assigned_user_id": "seed_will_id",
"assigned_user_link": {"full_name": "Will Westin", "id": "seed_will_id"},
"assigned_user_name": "Will Westin",
"attachment_list": [],
"cases": {"name": "", "id": ""}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
1777d22ad9b5-1 | "cases": {"name": "", "id": ""},
"category_id": "3e844f1c-5ce1-6d6d-496d-5714901e6666",
"category_name": "Database",
"created_by": "1",
"created_by_link": {"full_name": "Administrator", "id": "1"},
"created_by_name": "Administrator",
"date_entered": "2016-04-18T07:43:43+00:00",
"date_modified": "2016-04-18T07:43:43+00:00",
"deleted": false,
"description": "",
"exp_date": "2014-12-31",
"file_mime_type": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
1777d22ad9b5-2 | "file_mime_type": "",
"following": false,
"id": "87758ab5-75eb-451f-2bd7-571490d29d7a",
"is_external": false,
"kbarticle_id": "8862943c-022e-0385-908e-5714908ac792",
"kbarticle_name": "Resetting the device",
"kbarticles_kbcontents": {"name": "Resetting the device", "id": "8862943c-022e-0385-908e-5714908ac792"},
"kbdocument_body": "When things are not working as expected...", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
1777d22ad9b5-3 | "kbdocument_body": "When things are not working as expected...",
"kbdocument_id": "87a20b6b-3172-ad19-0ca5-571490bec118",
"kbdocument_name": "Resetting the device",
"kbdocuments_kbcontents": {"name": "Resetting the device", "id": "87a20b6b-3172-ad19-0ca5-571490bec118"},
"kbsapprover_id": "",
"kbsapprover_name": "",
"kbsapprovers_kbcontents": {"full_name": "", "id": ""},
"kbscase_id": "",
"kbscase_name": "",
"language": "en", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
1777d22ad9b5-4 | "kbscase_name": "",
"language": "en",
"modified_by_name": "Administrator",
"modified_user_id": "1",
"modified_user_link": {"full_name": "Administrator", "id": "1"},
"my_favorite": false,
"name": "Resetting the device",
"notuseful": 1
"related_languages": ["en"],
"revision": 1
"status": "in-review",
"tag": [],
"team_count": "",
"team_count_link": {"team_count": "", "id": "1"},
"team_name": [{"id": 1, "name": "Global", "name_2": "", "primary": true}], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsrecordnotuseful_PUT/index.html |
1777d22ad9b5-5 | "useful": 0,
"usefulness_user_vote": "-1",
"viewcount": 4
}
Change Log
Version
Change
v10
Added /KBContents/:record/useful PUT endpoint.
v10
Added /KBContents/:record/notuseful 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/KBContentsrecordnotuseful_PUT/index.html |
e220d38a80ee-0 | /TimePeriods/:date GET
Return a Timeperiod by a given date
Summary:
This endpoint is used to get a TimePeriod for a given date. If one is not found a 404 is returned.
Output Example:
{
"id":"e394485a-5889-ea75-84c8-51543bd1a5ba",
"name":"Q1 (01\/01\/2013 - 03\/31\/2013)",
"parent_id":"e28efe2d-c51c-be45-3d84-51543b4d2910",
"start_date":"2013-01-01",
"start_date_timestamp":"1356998400",
"end_date":"2013-03-31",
"end_date_timestamp":"1364774399", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsdate_GET/index.html |
e220d38a80ee-1 | "end_date_timestamp":"1364774399",
"created_by":"1",
"date_entered":"2013-03-28 12:46:36",
"date_modified":"2013-03-28 12:46:36",
"deleted":"0",
"is_fiscal":"0",
"is_fiscal_year":"0",
"leaf_cycle":"1",
"type":"Quarter",
"related_timeperiods":""
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriodsdate_GET/index.html |
fb35978de5b9-0 | /oauth2/sudo/:user_name POST
Overview
Get an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition.
Request Arguments
Name
Type
Description
Required
platform
String
Which platform on the session, defaults to "base"
False
client_id
String
The client id for the session, defaults to "sugar"
False
Request
{
"client_id":"sugar",
"platform":"base"
}
Response Arguments
Name
Type
Description
access_token
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2sudouser_name_POST/index.html |
fb35978de5b9-1 | Response Arguments
Name
Type
Description
access_token
String
The access token needed to authenticate for other methods.
expires_in
Integer
The length of time until the access_token expires.
token_type
String
Should always be bearer.
scope
String
There is no scope implementation in the current release of Sugar.
Response
{
"access_token":"c19fff9b-b767-233e-ebb4-512e369d3e39",
"expires_in":3600,
"token_type":"bearer",
"scope":null
}
Change Log
Version
Change
v10 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2sudouser_name_POST/index.html |
fb35978de5b9-2 | }
Change Log
Version
Change
v10
Added /oauth2/token/sudo/:user POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2sudouser_name_POST/index.html |
284efaf94d55-0 | /Reports/:record/:type GET
Overview
An API to run a saved report and export the result.
Summary
This endpoint will export the result of a saved report in one of the following formats: pdf, base64, csv, and json ('rows and columns' reports only).
Request Arguments
Name
Type
Description
Required
record
String
ID of a saved report
True
export_type
String
Format of exported data. It can be one of the following formats: pdf, base64, csv, and json. CSV and JSON export types are only currently available for 'Rows and Columns' reports.
True
Request Example
GET /rest/v11/Reports/:id/json
Response Example
[
{
"Contact ID":"fa300a0e-0ad1-b322-9601-512d0983c19a", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordtype_GET/index.html |
284efaf94d55-1 | "First Name":"Dale",
"Last Name":"Arvizu",
"Email Address":"[email protected]",
"Account Name":"DD Furniture Inc"
},
{
"Contact ID":"71c773ce-980e-11eb-8f85-f45c898a3ce7",
"First Name":"Isis",
"Last Name":"Arvizu",
"Email Address":"[email protected]",
"Account Name":"J.K.M. Corp (HA)"
},
]
Â
Change Log
Version
Change
v11.13
Added csv and json formats.
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/Reportsrecordtype_GET/index.html |
5a1a2704309b-0 | /pmse_Project/EventDefinition/:record GET
Overview
Retrieves the definition data for an event
Summary
This endpoint will retrieve the JSON encoded definition data for the Process
Definition event identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the evn_uid field in the pmse_bpmn_event record
True
Request
Note: Additional input parameters can be provided in the form
of a URL query string.
/rest/v11/pmse_Project/EventDefinition/632263607573cb74a582507093735454?related=modules
Response Arguments
Name
Type
Description
<field>
<value>
Field value in the pmse_bpmn_activity record
Response
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
5a1a2704309b-1 | Field value in the pmse_bpmn_activity record
Response
{
"id":"80a37c82-8be8-c668-a547-573cb791b905",
"name":"",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:41:42",
"created_by":"1",
"description":null,
"deleted":"0",
"evn_status":"ACTIVE",
"evn_type":"START",
"evn_module":"Accounts",
"evn_criteria":"",
"evn_params":"new",
"evn_script":"",
"execution_mode":"DEFAULT",
"au_first_name":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
5a1a2704309b-2 | "au_first_name":null,
"au_last_name":null,
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null,
"evn_uid":"632263607573cb74a582507093735454",
"related":
{
"modules":
[
{
"value":"Accounts",
"text":"Accounts"
},
{
"value":"Bugs",
"text":"Bugs"
},
{
"value":"Calls",
"text":"Calls"
},
{
"value":"Campaigns", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
5a1a2704309b-3 | },
{
"value":"Campaigns",
"text":"Campaigns"
},
{
"value":"Cases",
"text":"Cases"
},
{
"value":"Contacts",
"text":"Contacts"
},
{
"value":"Contracts",
"text":"Contracts"
},
{
"value":"Documents",
"text":"Documents"
},
{
"value":"KBContents",
"text":"Knowledge Base"
},
{
"value":"Leads",
"text":"Leads"
},
{
"value":"Meetings",
"text":"Meetings"
},
{
"value":"Notes",
"text":"Notes"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
5a1a2704309b-4 | {
"value":"Notes",
"text":"Notes"
},
{
"value":"Opportunities",
"text":"Opportunities"
},
{
"value":"ProductTemplates",
"text":"Product Catalog"
},
{
"value":"ProjectTask",
"text":"Project Tasks"
},
{
"value":"Project",
"text":"Projects"
},
{
"value":"Products",
"text":"Quoted Line Items"
},
{
"value":"Quotes",
"text":"Quotes"
},
{
"value":"RevenueLineItems",
"text":"Revenue Line Items"
},
{
"value":"Prospects", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
5a1a2704309b-5 | },
{
"value":"Prospects",
"text":"Targets"
},
{
"value":"Tasks",
"text":"Tasks"
}
]
}
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectEventDefinitionrecord_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.