id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
fed4ad49919b-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 |
5a70877e88a3-0 | /pmse_Emails_Templates/variables/find GET
Overview
Get the variable list for a module
Summary
This endpoint will retrieve a list of variables that can be used in the
Process Email Templates definition from the specified module. Input
parameters are passed in as the URL query string. Pagination is supported.
Request Arguments
Name
Type
Description
Required
base_module
String
The name of the target module of the Process Email Templates definition.
True
module_list
String
The name of the module the variable list is retrieved from.
Should be related to the base_module.
True
q
String
Only variables with name containing this search string will be returned.
False
max_num
Integer
Maximum number of variables to return for this request.
False
offset
Integer
The index of the first variable in the whole list to return for this request.
Use "end" to indicate no variable should be returned.
False
order_by
String
Property to sort the variable list by. For example, "name:asc,id:desc"
will sort the returned variable list by name ASC first and then id DESC.
False
Request
rest/v11/pmse_Emails_Templates/variables/find?max_num=20&order_by=date_modified%3Adesc&module_list=Quotes&base_module=Quotes
Response Arguments
Name
Type
Description
next_offset
Integer
The offset value that should be used to retrieve the next batch of the list.
records
Array
A sorted array of variable objects.
Response
{
"next_offset":20,
"records":[
{
"id":"date_quote_expected_closed",
"_module":"Quotes",
"name":"Valid Until",
"rhs_module":"Quotes"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html |
5a70877e88a3-1 | "rhs_module":"Quotes"
},
{
"id":"total_usdollar",
"_module":"Quotes",
"name":"Total (US Dollar)",
"rhs_module":"Quotes"
},
{
"id":"total",
"_module":"Quotes",
"name":"Total",
"rhs_module":"Quotes"
},
{
"id":"tax_usdollar",
"_module":"Quotes",
"name":"Tax (US Dollar)",
"rhs_module":"Quotes"
},
{
"id":"tax",
"_module":"Quotes",
"name":"Tax",
"rhs_module":"Quotes"
},
{
"id":"subtotal_usdollar",
"_module":"Quotes",
"name":"Subtotal (US Dollar)",
"rhs_module":"Quotes"
},
{
"id":"subtotal",
"_module":"Quotes",
"name":"Subtotal",
"rhs_module":"Quotes"
},
{
"id":"shipping_address_state",
"_module":"Quotes",
"name":"Shipping State",
"rhs_module":"Quotes"
},
{
"id":"shipping_address_postalcode",
"_module":"Quotes",
"name":"Shipping Postal Code",
"rhs_module":"Quotes"
},
{
"id":"shipping_address_country",
"_module":"Quotes",
"name":"Shipping Country",
"rhs_module":"Quotes"
},
{
"id":"shipping_address_city",
"_module":"Quotes",
"name":"Shipping City",
"rhs_module":"Quotes"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html |
5a70877e88a3-2 | "rhs_module":"Quotes"
},
{
"id":"shipping_address_street",
"_module":"Quotes",
"name":"Shipping Address",
"rhs_module":"Quotes"
},
{
"id":"shipping_usdollar",
"_module":"Quotes",
"name":"Shipping (US Dollar)",
"rhs_module":"Quotes"
},
{
"id":"shipping",
"_module":"Quotes",
"name":"Shipping",
"rhs_module":"Quotes"
},
{
"id":"quote_type",
"_module":"Quotes",
"name":"Quote Type",
"rhs_module":"Quotes"
},
{
"id":"name",
"_module":"Quotes",
"name":"Quote Subject",
"rhs_module":"Quotes"
},
{
"id":"quote_stage",
"_module":"Quotes",
"name":"Quote Stage",
"rhs_module":"Quotes"
},
{
"id":"quote_num",
"_module":"Quotes",
"name":"Quote Number",
"rhs_module":"Quotes"
},
{
"id":"purchase_order_num",
"_module":"Quotes",
"name":"Purchase Order Num",
"rhs_module":"Quotes"
},
{
"id":"payment_terms",
"_module":"Quotes",
"name":"Payment Terms",
"rhs_module":"Quotes"
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html |
642c95028bc0-0 | /ForecastManagerWorksheets/:timeperiod_id GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return the ManagerWorksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
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/:timeperiod_id/:user_id
Output Example:
{
"next_offset":-1,
"records":[
{
"id":"401594f5-5b46-fb66-1627-55771fe8723e",
"name":"Sally Bronsen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"1932.444445",
"best_case":"29848.000000",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556",
"worst_case":"27540.888889",
"worst_case_adjusted":"34426.111111", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
642c95028bc0-1 | "worst_case_adjusted":"34426.111111",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_sally_id",
"opp_count":10,
"pipeline_opp_count":3,
"pipeline_amount":"2415.555556",
"closed_amount":"26278.888889",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"28226f12-a3c9-bd84-041e-55771f064c4e",
"name":"Max Jensen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"3141.333332",
"best_case":"15848.222223",
"best_case_adjusted":"13206.851853",
"likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
642c95028bc0-2 | "likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"worst_case_adjusted":"11673.518519",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_max_id",
"opp_count":12,
"pipeline_opp_count":3,
"pipeline_amount":"2617.777777",
"closed_amount":"12310.444445",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"1aca66af-f069-bba4-28a1-55771fe27506",
"name":"",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"10142.333333",
"best_case":"37625.000000",
"best_case_adjusted":"37625.000000",
"likely_case":"34241.333333", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
642c95028bc0-3 | "likely_case":"34241.333333",
"likely_case_adjusted":"34241.333333",
"worst_case":"30857.666667",
"worst_case_adjusted":"30857.666667",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":true,
"user_id":"seed_sarah_id",
"opp_count":13,
"pipeline_opp_count":6,
"pipeline_amount":"10142.333333",
"closed_amount":"24099.000000",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
}
]
}
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/ForecastManagerWorksheetstimeperiod_id_GET/index.html |
02025b6c571b-0 | /me/password PUT
Overview
Create a new record of a specified type.
Summary
This endpoint allows for changes to 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
old_password
String
The current password.
True
new_password
String
The new password.
True
Request
{
"old_password":"myoldpass",
"new_password":"mynewpass"
}
Response Arguments
Name
Type
Description
valid
Boolean
Returns the success of the password verification.
expiration
Date
When the password will expire.
Response
{
"valid":true,
"expiration":null
}
Change Log
Version
Change
v10
Added /me/password 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/mepassword_PUT/index.html |
337871b993ef-0 | /ForecastManagerWorksheets GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return the ManagerWorksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
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/:timeperiod_id/:user_id
Output Example:
{
"next_offset":-1,
"records":[
{
"id":"401594f5-5b46-fb66-1627-55771fe8723e",
"name":"Sally Bronsen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"1932.444445",
"best_case":"29848.000000",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556",
"worst_case":"27540.888889",
"worst_case_adjusted":"34426.111111", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
337871b993ef-1 | "worst_case_adjusted":"34426.111111",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_sally_id",
"opp_count":10,
"pipeline_opp_count":3,
"pipeline_amount":"2415.555556",
"closed_amount":"26278.888889",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"28226f12-a3c9-bd84-041e-55771f064c4e",
"name":"Max Jensen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"3141.333332",
"best_case":"15848.222223",
"best_case_adjusted":"13206.851853",
"likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
337871b993ef-2 | "likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"worst_case_adjusted":"11673.518519",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_max_id",
"opp_count":12,
"pipeline_opp_count":3,
"pipeline_amount":"2617.777777",
"closed_amount":"12310.444445",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"1aca66af-f069-bba4-28a1-55771fe27506",
"name":"",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"10142.333333",
"best_case":"37625.000000",
"best_case_adjusted":"37625.000000",
"likely_case":"34241.333333", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheets_GET/index.html |
337871b993ef-3 | "likely_case":"34241.333333",
"likely_case_adjusted":"34241.333333",
"worst_case":"30857.666667",
"worst_case_adjusted":"30857.666667",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":true,
"user_id":"seed_sarah_id",
"opp_count":13,
"pipeline_opp_count":6,
"pipeline_amount":"10142.333333",
"closed_amount":"24099.000000",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
}
]
}
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/ForecastManagerWorksheets_GET/index.html |
09421be654fc-0 | /Accounts/:record/link/:link_name/filter GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned. This argument
can be combined with the view argument.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-1 | False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-2 | $is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-3 | ]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Repsonse
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-4 | "first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-5 | "alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-6 | "modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-7 | ],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
09421be654fc-8 | "portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Accountsrecordlinklink_namefilter_GET/index.html |
fe3885dc8d29-0 | /pmse_Inbox/settings GET
Overview
Retrieve settings for the PA engine
Summary
This endpoint gets settings for the SugarBPMTM engine
Request Arguments
Name
Type
Description
Required
fields
string
Comma separated list of SugarBPMTM config keys to return. If not sent, all config settings will be returned.
false
Response Arguments
Name
Type
Description
logger_level
string
Level of logging
error_number_of_cycles
integer
Error number of cycles
error_timeout
integer
Timeout for errors
Response
{
"logger_level":"critical",
"error_number_of_cycles":"10",
"error_timeout":"40"
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxsettings_GET/index.html |
7d23012ac5cf-0 | /connector/twitter/:twitterId GET
Overview
Responds with twitter timeline if connector is set up in administration
Request Arguments
Name
Type
Description
Required
count
Integer
The number of tweets to retrieve.
False
Response Arguments
Name
Type
Description
<response>
String
Response
[
{
"created_at":"Tue Jun 25 23:45:35 +0000 2013",
"id":349674766946414592,
"id_str":"349674766946414592",
"text":"this tweet is awesome!",
"source":"web",
"truncated":false,
"in_reply_to_status_id":null,
"in_reply_to_status_id_str":null,
"in_reply_to_user_id":143456975,
"in_reply_to_user_id_str":"14934565",
"in_reply_to_screen_name":"testdesk",
"user":{
"id":2630841,
"id_str":"2630841",
"name":"SugarCRM",
"screen_name":"sugarcrm",
"location":"Cupertino, CA",
"description":"Everyone Sells. Everyone Supports. Everyone Connects.",
"url":"http:\/\/t.co\/s9ejrBSlki",
"entities":{
"url":{
"urls":[
{
"url":"http:\/\/t.co\/s9ejrBSlki",
"expanded_url":"http:\/\/www.sugarcrm.com",
"display_url":"sugarcrm.com",
"indices":[
0,
22
]
}
]
},
"description":{
"urls":[ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html |
7d23012ac5cf-1 | }
]
},
"description":{
"urls":[
]
}
},
"protected":false,
"followers_count":8761,
"friends_count":6966,
"listed_count":453,
"created_at":"Wed Mar 28 07:16:58 +0000 2007",
"favourites_count":27,
"utc_offset":-28800,
"time_zone":"Pacific Time (US \u0026 Canada)",
"geo_enabled":false,
"verified":false,
"statuses_count":7488,
"lang":"en",
"contributors_enabled":false,
"is_translator":false,
"profile_background_color":"98C7EA",
"profile_background_image_url":"http:\/\/a0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_image_url_https":"https:\/\/si0.twimg.com\/profile_background_images\/551274192\/sugar-twitter-background.png",
"profile_background_tile":false,
"profile_image_url":"http:\/\/a0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_image_url_https":"https:\/\/si0.twimg.com\/profile_images\/2027721183\/Sugar_cube_RGB_180x180_normal.png",
"profile_link_color":"0045AD",
"profile_sidebar_border_color":"FFFFFF",
"profile_sidebar_fill_color":"CCEAFF",
"profile_text_color":"000000",
"profile_use_background_image":true,
"default_profile":false,
"default_profile_image":false,
"following":null,
"follow_request_sent":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html |
7d23012ac5cf-2 | "following":null,
"follow_request_sent":false,
"notifications":null
},
"geo":null,
"coordinates":null,
"place":null,
"contributors":null,
"retweet_count":1,
"favorite_count":0,
"entities":{
"hashtags":[
],
"symbols":[
],
"urls":[
],
"user_mentions":[
{
"screen_name":"testdesk",
"name":"testdesk",
"id":143455,
"id_str":"ertrt75",
"indices":[
0,
8
]
}
],
"media":[
]
},
"favorited":false,
"retweeted":false,
"possibly_sensitive":false,
"lang":"en"
}
]
Change Log
Version
Change
v10
Added /twitter/{twitterId} GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectortwittertwitterId_GET/index.html |
6ad1295dfaab-0 | /Administration/packages/:id/uninstall GET
Overview
[ADMIN] PackageManager uninstall a package.
Summary
Uninstalls the specified package. Package id hash must be provided. Package id could be found in installed package list.
Response
Returns http status 200 OK and newly installed package ID if request is successful. Otherwise returns http status 4xx with errors.
{
"error": "not_found",
"error_message": "Could not find package by ID."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:id/uninstall 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/Administrationpackagesiduninstall_GET/index.html |
b601ac57f563-0 | /Administration/packages/:unFile DELETE
Overview
[ADMIN] PackageManager delete a package.
Summary
Delete the specified package. Package 'unFile' hash must be provided. Package 'unFile' hash could be found in staging package list.
Response
Returns http status 200 OK if request is successful. Otherwise returns http status 4xx with errors.
{
"error": "delete_package_error",
"error_message": "Could not find package file."
}
Change Log
Version
Change
v11.8
Added /Administration/packages/:unFile 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/AdministrationpackagesunFile_DELETE/index.html |
4b9fc73bb124-0 | /Administration/idm/migration/enable POST
Overview
[ADMIN] Enable Idm migrations
Summary
This endpoint enables Idm migrations. This endpoint is only available to administrators.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"success": true
}
Change Log
Version
Change
v11_2
Added Administration/idm/migration/enable POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmmigrationenable_POST/index.html |
199dee51c4d6-0 | /<module>/insertafter/:target POST
Overview
Insert new node after target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to insert new node after
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",
"name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertaftertarget_POST/index.html |
199dee51c4d6-1 | "_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/insertafter/:target 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/moduleinsertaftertarget_POST/index.html |
e1c2388f68d7-0 | /<module>/filter POST
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-1 | constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example
you would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-2 | Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-3 | filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-4 | "primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-5 | "primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-6 | "name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-7 | "primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
e1c2388f68d7-8 | "reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html |
963fc59d28c2-0 | /Emails/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
The filter expression. Filter expressions are explained below.
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-1 | constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example
you would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-2 | Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-3 | filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-4 | "primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-5 | "primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-6 | "name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-7 | "primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
963fc59d28c2-8 | "reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfiltercount_GET/index.html |
db4b43dc720e-0 | /<module>/:record/unfavorite PUT
Overview
Removes a record of a specified type as a favorite for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html |
db4b43dc720e-1 | "linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html |
db4b43dc720e-2 | },
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordunfavorite_PUT/index.html |
cb1d4e1bdf76-0 | /Emails/:record GET
Overview
Retrieves an Emails record.
Fields
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
from_collection
List
The email's sender.
to_collection
List
The email's recipients found in the TO field.
cc_collection
List
The email's recipients found in the CC field.
bcc_collection
List
The email's recipients found in the BCC field.
attachments_collection
List
The email's attachments.
Request
GET /Emails/a028341c-ba92-9343-55e7-56cf5beda121?fields=name,state,
{"name":"from_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"to_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"cc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"bcc_collection","fields":["email_address","email_address_id",
"parent_type","parent_id","parent_name"]},
{"name":"attachments_collection","fields":["name","filename","file_size",
"file_source","file_mime_type","file_ext","upload_id"]}
Response
{
"id": "a028341c-ba92-9343-55e7-56cf5beda121",
"state": "Archived",
"name": "Re: Discuss Proposal", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
cb1d4e1bdf76-1 | "state": "Archived",
"name": "Re: Discuss Proposal",
"from_collection": {
"next_offset": {
"from": -1
},
"records": [{
"id": "ec113d14-7d27-11e7-a951-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ec05a896-7d27-11e7-a51e-3c15c2d582c6",
"parent_type": "Leads",
"parent_id": "f6a0611a-7d27-11e7-9d70-3c15c2d582c6",
"parent_name": "Tom Davis",
"_acl": {
"fields": {}
},
"_link": "from",
"_module": "EmailParticipants"
}]
},
"to_collection": {
"next_offset": {
"to": -1
},
"records": [{
"id": "ec0f1278-7d27-11e7-8d1f-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ec0fb516-7d27-11e7-b7ad-3c15c2d582c6",
"parent_type": "Users",
"parent_id": "9c61c46a-a7c5-df71-481c-51d48232f820",
"parent_name": "Sarah Smith",
"_acl": {
"fields": {}
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
cb1d4e1bdf76-2 | "_acl": {
"fields": {}
},
"_link": "to",
"_module": "EmailParticipants"
}]
},
"cc_collection": {
"next_offset": {
"cc": -1
},
"records": [{
"id": "eafa7e9a-7d27-11e7-aa2b-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ea1cec7e-7d27-11e7-9845-3c15c2d582c6",
"parent_type": "Users",
"parent_id": "e087e79a-7d27-11e7-b02c-3c15c2d582c6",
"parent_name": "Brian Roland",
"_acl": {
"fields": {}
},
"_link": "cc",
"_module": "EmailParticipants"
}, {
"id": "df5eb204-7d27-11e7-b363-3c15c2d582c6",
"email_address": "[email protected]",
"email_address_id": "ddf1d9e6-7d27-11e7-bb17-3c15c2d582c6",
"parent_type": "",
"parent_id": "",
"parent_name": "",
"_acl": {
"fields": {}
},
"_link": "cc",
"_module": "EmailParticipants"
}]
},
"bcc_collection": {
"next_offset": {
"bcc": -1 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecord_GET/index.html |
cb1d4e1bdf76-3 | "next_offset": {
"bcc": -1
},
"records": []
},
"attachments_collection": {
"next_offset": {
"attachments": -1
},
"records": [{
"id": "afe9702e-53a3-0efb-6bbe-56c3580885ef",
"name": "Quote.pdf",
"filename": "Quote.pdf",
"upload_id": "",
"file_mime_type": "application/pdf",
"file_size": 158589,
"file_source": "DocumentRevisions",
"file_ext": "pdf"
"_acl": {
"fields": {}
},
"_link": "attachments",
"_module": "Notes"
}]
}
"_acl": {
"fields": [
]
},
"_module": "Emails"
}
Change Log
Version
Change
v10
Added /Emails/: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/Emailsrecord_GET/index.html |
5a9c34ca032c-0 | /me/preferences PUT
Overview
Mass updates preferences for the user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preferences PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepreferences_PUT/index.html |
e7a7b81a8818-0 | /pmse_Project/CrmData/:data/:filter GET
Overview
Retrieves information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will retrieve 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
Request
Note: Additional input parameters can be provided in the form
of a URL query string.
/rest/v11/pmse_Project/CrmData/related/Accounts?cardinality=one
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
search
String
The value of the filter input parameter
result
Array
The data requested
Response
{
"search":"Accounts",
"success":true,
"result":
[
{
"value":"Accounts",
"text":"\u003CAccounts\u003E",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"Accounts"
},
{
"value":"member_of",
"text":"Accounts (Member of: member_of)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"member_accounts"
},
{
"value":"campaign_accounts",
"text":"Campaigns (Campaigns: campaign_accounts)",
"module":"Campaigns",
"module_label":"Campaigns",
"module_name":"Campaigns",
"relationship":"campaign_accounts"
},
{
"value":"assigned_user_link",
"text":"Users (Assigned to User: assigned_user_link)", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html |
e7a7b81a8818-1 | "text":"Users (Assigned to User: assigned_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_assigned_user"
},
{
"value":"created_by_link",
"text":"Users (Created by User: created_by_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_created_by"
},
{
"value":"modified_user_link",
"text":"Users (Modified by User: modified_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_modified_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/pmse_ProjectCrmDatadatafilter_GET/index.html |
dc56b6f98d0d-0 | /Teams/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing record.
Query String Parameters
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record linked to the related record.
related_record
Array
The record that was associated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
"name":"Slender Broadband Inc - 1000 units",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-28T18:21:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
dc56b6f98d0d-1 | "opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
dc56b6f98d0d-2 | "deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
dc56b6f98d0d-3 | "primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlinklink_nameremote_id_POST/index.html |
dc56b6f98d0d-4 | "my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/: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/Teamsrecordlinklink_nameremote_id_POST/index.html |
052f1b9b2a98-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"
}
]
}
}
Link fields
It is possible to add or delete record relations to other records and create new related records.
Action
Type
Description
add
List
List of related records ID. See RelateRecordApi
for details.
delete
List
List of related records ID.
create
List
List of name to value arrays of related records.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the updated record.
Response
{
"id":"f222265a-b755-da89-0bc7-512d09b800b6",
"name":"New Account Name",
"date_entered":"2013-02-26T19:12:00+00:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
052f1b9b2a98-1 | "date_modified":"2013-02-27T22:49:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Hospitality",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"9 IBM Path",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Francisco",
"billing_address_state":"CA",
"billing_address_postalcode":"43635",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(555) 888-5555",
"phone_alternate":"",
"website":"www.newsite.com",
"ownership":"",
"employees":"",
"ticker_symbol":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
052f1b9b2a98-2 | "ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"9 IBM Path",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Francisco",
"shipping_address_state":"CA",
"shipping_address_postalcode":"43635",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesrecord_PUT/index.html |
a2b4ddbe627e-0 | /<module>/favorites POST
Overview
Opportunity Favorites Help
Summary
This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
"Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
pageNum
integer
An integer attribute in the payload data object which gets the page number for which the items need to be
displayed based on the current page or the page clicked.
False
Request
{
pageNum: 0
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"totalPages":5,
"pageNum":0,
"max_num":8,
"records":[
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-1 | "vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-2 | "category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-3 | "description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-4 | "name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-5 | "base_rate":"1.000000"
},
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-6 | "support_contact":null,
"support_term":null,
"pricing_formula":"PercentageDiscount",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1baf0e8-c7f2-11e8-ab05-7831c1c14620",
"name":"Carley Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Hollywood Diner Ltd 10023XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"554.000000",
"discount_price":"559.595960",
"list_price":"927.000000",
"cost_usdollar":"554.000000",
"discount_usdollar":"559.595959",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-7 | "date_available":"2004-10-15",
"website":null,
"weight":"30.00",
"qty_in_stock":58,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b77544-c7f2-11e8-8347-7831c1c14620",
"name":"Carma Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Sea Region Inc 773472XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"332.000000",
"discount_price":"745.000000",
"list_price":"822.000000",
"cost_usdollar":"332.000000",
"discount_usdollar":"745.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-8 | "discount_usdollar":"745.000000",
"list_usdollar":"822.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"35.00",
"qty_in_stock":1,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b98c9e-c7f2-11e8-9740-7831c1c14620",
"name":"Catrina Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b8e4ec-c7f2-11e8-b435-7831c1c14620",
"mft_part_num":"Jungle Systems Inc 273034XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"577.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_POST/index.html |
a2b4ddbe627e-9 | "date_cost_price":null,
"cost_price":"577.000000",
"discount_price":"582.770000",
"list_price":"946.000000",
"cost_usdollar":"577.000000",
"discount_usdollar":"582.770000",
"list_usdollar":"946.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"13.00",
"qty_in_stock":105,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"PercentageMarkup",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
}
]
}
Change Log
Version
Change
v10
Added /Opportunities/favorites 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/modulefavorites_POST/index.html |
c5166ebee5a1-0 | /<module>/:record/movefirst/:target PUT
Overview
Move existing node as first child of target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to move node as first child
True
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint return a record GUID that was moved
"1b7b868d-7357-2e29-7513-54169bdc444d"
Change Log
Version
Change
v10
Added /<module>/movefirst/:target 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/modulerecordmovefirsttarget_PUT/index.html |
bf43c88da13b-0 | /EmbeddedFiles/:record/file/:field PUT
Overview
This endpoint takes a file or image and saves it to a record that already contains an attachment in the specified field. The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query parameter can be sent with the request to assign a name. Additionally, the PUT
method can accept base64 encoded file data which will be decoded by the endpoint
if the content_transfer_encoding parameter is set to 'base64'.NOTE: In lieu of the content_transfer_encoding parameter, a
request header of X-Content-Transfer-Encoding can also be sent with a value
of 'base64'. In the event both the content transfer encoding header and request
parameter are sent, the header will be used.
Request Arguments
Name
Type
Description
Required
filename
String
Filename to save the document as
False
content_transfer_encoding
String
When set to 'base64', indicates the file contents are base64 encoded
and will result in the file contents being base64 decoded before being
saved
False
Request
PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be
Response Arguments
Name
Type
Description
field
Array
The fields containing file properties.
field.content-type
String
The files content type.
field.content-length
Integer
The files content length. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/EmbeddedFilesrecordfilefield_PUT/index.html |
bf43c88da13b-1 | Integer
The files content length.
field.name
String
The files name.
field.width
Integer
The width of the image.
field.height
Integer
The height of the image.
field.uri
String
The URI of the file.
Response
{
"picture":{
"content-type":"image\/png",
"content-length":72512,
"name":"1a7b8f5c-b11c-0094-c8d8-512e9daaa983",
"width":933,
"height":519,
"uri":"http:\/\/sugarcrm\/rest\/v10\/Contacts\/fa300a0e-0ad1-b322-9601-512d0983c19a\/file\/picture"
}
"attachment":{
"content-type":"application/document-doc",
"content-length":"873921",
"name":"myFile.doc",
"uri": "http:\/\/sugarcrm\/rest\/v10\/Contacts\/f2f9aa4d-99a8-e86e-f4d5-512d0986effa\/file\/attachment"
}
}
Change Log
Version
Change
v10
Added /<module>/:record/file/:field 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/EmbeddedFilesrecordfilefield_PUT/index.html |
5aa1040c57da-0 | /pmse_Project/CrmData/:record/:filter PUT
Overview
Updates information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will update various data related to the Process Definition
with the data provided in the request payload.
Request Arguments
Name
Type
Description
Required
record
String
The type of data to be updated
True
filter
String
Filtering criteria to be applied to data updated
False
Request
/rest/v11/pmse_Project/CrmData/clearEventCriteria/383414365573cf64b8eaa65039872849
Request Payload
{
"data":null
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
"success":true
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatarecordfilter_PUT/index.html |
032c28350b74-0 | /Quotes/:record/opportunity POST
Overview
Quote Convert to Opportunity
Summary
This endpoint converts a Quote to an Opportunity.
Request Arguments
NONE
Response Arguments
NONE
Response
Created Opportunity:
{
"record": {
"id": "31a601ee-2d3f-11e8-bfae-024289eecda3",
"name": "Mirrors for J.K.M. Corp (HA)",
"date_entered": "2018-03-21T19:36:47+00:00",
"date_modified": "2018-03-21T19:36:47+00:00",
"modified_user_id": "1",
"modified_by_name": "admin",
"modified_user_link": {
"full_name": "admin",
"id": "1",
"_acl": {
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
},
"last_login": {
"write": "no",
"create": "no"
}
},
"delete": "no",
"_hash": "08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"created_by": "1",
"created_by_name": "",
"created_by_link": {
"full_name": "",
"id": "1",
"_acl": {
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
},
"last_login": {
"write": "no", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-1 | },
"last_login": {
"write": "no",
"create": "no"
}
},
"delete": "no",
"_hash": "08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"deleted": false,
"opportunity_type": "New Business",
"account_name": "",
"accounts": {
"name": "",
"id": "0029279c-2d3d-11e8-a121-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"account_id": "0029279c-2d3d-11e8-a121-024289eecda3",
"campaign_name": "",
"campaign_opportunities": {
"name": "",
"id": null,
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"amount": "520.000000",
"amount_usdollar": "520.000000",
"date_closed": "2012-04-30",
"date_closed_timestamp": 1335744000,
"sales_stage": "Prospecting",
"sales_status": "In Progress",
"probability": 10,
"best_case": "520.000000",
"worst_case": "520.000000", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-2 | "worst_case": "520.000000",
"commit_stage": "exclude",
"total_revenue_line_items": 1,
"closed_revenue_line_items": 0,
"included_revenue_line_items": 0,
"mkto_sync": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"assigned_user_link": {
"full_name": "Max Jensen",
"id": "seed_max_id",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"team_id": "1",
"team_set_id": "1",
"acl_team_set_id": "f846e71c-2d3c-11e8-a9e4-024289eecda3",
"team_count": "",
"team_count_link": {
"team_count": "",
"id": "1",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"currency_id": "-99",
"base_rate": "1.000000",
"currency_name": "",
"currencies": {
"name": "",
"id": "-99",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
},
"symbol": ""
},
"currency_symbol": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-3 | },
"symbol": ""
},
"currency_symbol": "",
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Opportunities"
},
"related_record": {
"id": "23d19cec-2d3d-11e8-b4bf-024289eecda3",
"name": "Mirrors for J.K.M. Corp (HA)",
"date_entered": "2018-03-21T19:20:19+00:00",
"date_modified": "2018-03-21T19:36:47+00:00",
"modified_user_id": "1",
"modified_by_name": "admin",
"modified_user_link": {
"full_name": "admin",
"id": "1",
"_acl": {
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
},
"last_login": {
"write": "no",
"create": "no"
}
},
"delete": "no",
"_hash": "08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"created_by": "1",
"created_by_name": "Administrator",
"created_by_link": {
"full_name": "Administrator",
"id": "1",
"_acl": {
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-4 | "write": "no",
"create": "no"
},
"last_login": {
"write": "no",
"create": "no"
}
},
"delete": "no",
"_hash": "08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"description": "",
"deleted": false,
"shipper_id": "",
"shipper_name": "",
"shippers": {
"name": "",
"id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"taxrate_id": "2254f224-2d3d-11e8-925e-024289eecda3",
"taxrate_name": "8.25 - Cupertino, CA",
"taxrates": {
"name": "8.25 - Cupertino, CA",
"id": "2254f224-2d3d-11e8-925e-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"taxrate_value": "8.250000",
"show_line_nums": true,
"quote_type": "Quotes",
"date_quote_expected_closed": "2012-04-30",
"original_po_date": "",
"payment_terms": "Net 15",
"date_quote_closed": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-5 | "payment_terms": "Net 15",
"date_quote_closed": "",
"date_order_shipped": "",
"order_stage": "",
"quote_stage": "Negotiation",
"purchase_order_num": "3940021",
"quote_num": 2,
"subtotal": "520.000000",
"subtotal_usdollar": "520.000000",
"shipping": "0.000000",
"shipping_usdollar": "0.000000",
"discount": "",
"deal_tot": "0.000000",
"deal_tot_discount_percentage": 0,
"deal_tot_usdollar": "0.000000",
"new_sub": "520.000000",
"new_sub_usdollar": "520.000000",
"taxable_subtotal": "520.000000",
"tax": "42.900000",
"tax_usdollar": "42.900000",
"total": "562.900000",
"total_usdollar": "562.900000",
"billing_address_street": "111 Silicon Valley Road",
"billing_address_city": "Kansas City",
"billing_address_state": "CA",
"billing_address_postalcode": "47108",
"billing_address_country": "USA",
"shipping_address_street": "111 Silicon Valley Road",
"shipping_address_city": "Kansas City",
"shipping_address_state": "CA",
"shipping_address_postalcode": "47108",
"shipping_address_country": "USA",
"shipping_account_name": "",
"shipping_accounts": {
"name": "", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-6 | "shipping_accounts": {
"name": "",
"id": "0029279c-2d3d-11e8-a121-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"shipping_account_id": "",
"shipping_contact_name": "",
"shipping_contacts": {
"full_name": "",
"id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"shipping_contact_id": "",
"account_name": "J.K.M. Corp (HA)",
"billing_accounts": {
"name": "J.K.M. Corp (HA)",
"id": "0029279c-2d3d-11e8-a121-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"account_id": "0029279c-2d3d-11e8-a121-024289eecda3",
"billing_account_name": "J.K.M. Corp (HA)",
"billing_account_id": "0029279c-2d3d-11e8-a121-024289eecda3",
"billing_contact_name": "",
"billing_contacts": {
"full_name": "",
"id": "",
"_acl": {
"fields": [], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html |
032c28350b74-7 | "id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"billing_contact_id": "",
"opportunity_name": "",
"opportunities": {
"name": "",
"id": "23d19cec-2d3d-11e8-b4bf-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"opportunity_id": "",
"following": "",
"my_favorite": false,
"tag": [],
"locked_fields": [],
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"assigned_user_link": {
"full_name": "Max Jensen",
"id": "seed_max_id",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"team_count": "",
"team_count_link": {
"team_count": "",
"id": "1",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"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/Quotesrecordopportunity_POST/index.html |
032c28350b74-8 | "name_2": "",
"primary": true,
"selected": false
}],
"currency_id": "-99",
"base_rate": "1.000000",
"currency_name": "",
"currencies": {
"name": "",
"id": "-99",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
},
"symbol": ""
},
"currency_symbol": "",
"_acl": {
"fields": {}
},
"_module": "Quotes"
}
}
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/Quotesrecordopportunity_POST/index.html |
35758aceb33f-0 | /KBContents/config POST
Creates and/or updates the config settings for the KBContents module
Summary:
This endpoint is used to create and/or update the config settings for the KBContents module as json data.
It extends the core config endpoint by adding the functionality to process deleted languages and documents
related to them.
Query Parameters:
Param
Description
Optional
Input Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
Output Example:
{
"languages":[{
"en":"English",
"primary":true
},{
"de":"German",
"primary":false
}],
"category_root":"31696245-0438-ff7a-9144-544f8c659daf",
"deleted_languages":["es","ru"]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsconfig_POST/index.html |
40838991658c-0 | /Administration/packages/staged GET
Overview
[ADMIN] PackageManager lists staged packages.
Summary
Lists staged packages in the system.
Response
{
"packages": [
{
"name": "project_P1",
"version": 1580885419,
"published_date": "2020-02-05 06:50:19",
"description": "None",
"uninstallable": "Yes",
"type": "Module",
"file": "0ef4dd8b237f4358bdb246a744eb2b38",
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392"
}
]
}
Change Log
Version
Change
v11.8
Added /Administration/packages/staged 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/Administrationpackagesstaged_GET/index.html |
d9eb6fc455b1-0 | /ping/whattimeisit GET
Overview
Responds with the current time in server format.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<server time>
String
Returns the servers time.
Response
<time>
Change Log
Version
Change
v10
Added /ping/whattimeisit 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/pingwhattimeisit_GET/index.html |
a3262e46f0ec-0 | /<module>/sync_key/:sync_key_field_value PUT
Overview
Upserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method.
Note:Â This endpoint cannot be used to set the sync_key for an existing Sugar record. To do so, it is recommended to use the set sync key endpoint to update the matching Sugar record ID. Once the sync_key is set for the record, then it is possible to leverage this endpoint.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
/<module>/sync_key/:sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record that was upserted.
Response
Status 201: For a created record
Status 200: For an updated record
{ record: "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
Added /<module>/sync_key/:sync_key_field_value PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_PUT/index.html |
0a6b4e33bee3-0 | /<module>/favorites GET
Overview
Opportunity Favorites Help
Summary
This endpoint returns all the favorite Quotes/Revenue Line Items in alphabetical order to be displayed in the
"Product Catalog Quick Picks" dashlet.
Request Arguments
Name
Type
Description
Required
pageNum
integer
An integer attribute in the payload data object which gets the page number for which the items need to be
displayed based on the current page or the page clicked.
False
Request
{
pageNum: 0
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"totalPages":5,
"pageNum":0,
"max_num":8,
"records":[
{
"id":"c181bd32-c7f2-11e8-b4eb-7831c1c14620",
"name":"Allyson Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c18112d8-c7f2-11e8-b753-7831c1c14620",
"mft_part_num":"Ink Conglomerate Inc 921535XYZ987", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
0a6b4e33bee3-1 | "vendor_part_num":null,
"date_cost_price":null,
"cost_price":"534.000000",
"discount_price":"842.000000",
"list_price":"905.000000",
"cost_usdollar":"534.000000",
"discount_usdollar":"842.000000",
"list_usdollar":"905.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"20.00",
"qty_in_stock":26,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"Fixed",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c18e0448-c7f2-11e8-86b0-7831c1c14620",
"name":"Arla Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
0a6b4e33bee3-2 | "category_id":"c18b8b64-c7f2-11e8-8c1a-7831c1c14620",
"mft_part_num":"24\/7 Couriers 795391XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"398.000000",
"discount_price":"402.020202",
"list_price":"941.000000",
"cost_usdollar":"398.000000",
"discount_usdollar":"402.020202",
"list_usdollar":"941.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"22.00",
"qty_in_stock":145,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c1b60434-c7f2-11e8-8964-7831c1c14620",
"name":"Billie Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
0a6b4e33bee3-3 | "description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Kringle Bell IncK.A. Tower \u0026 Co 694143XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"403.000000",
"discount_price":"927.000000",
"list_price":"927.000000",
"cost_usdollar":"403.000000",
"discount_usdollar":"927.000000",
"list_usdollar":"927.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"16.00",
"qty_in_stock":148,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"IsList",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{
"id":"c186a612-c7f2-11e8-9fee-7831c1c14620",
"name":"Bradford Gadget", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
0a6b4e33bee3-4 | "name":"Bradford Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c185dbb0-c7f2-11e8-a6b7-7831c1c14620",
"mft_part_num":"Mississippi Bank Group 133834XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"528.000000",
"discount_price":"533.333333",
"list_price":"745.000000",
"cost_usdollar":"528.000000",
"discount_usdollar":"533.333333",
"list_usdollar":"745.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"33.00",
"qty_in_stock":70,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null,
"pricing_formula":"ProfitMargin",
"pricing_factor":"1.00",
"assigned_user_id":null,
"currency_id":"-99",
"base_rate":"1.000000"
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
0a6b4e33bee3-5 | "base_rate":"1.000000"
},
{
"id":"c1b4680e-c7f2-11e8-9380-7831c1c14620",
"name":"Brain Gadget",
"date_entered":"2018-10-04 16:28:37",
"date_modified":"2018-10-04 16:28:37",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":0,
"type_id":null,
"manufacturer_id":"c03f952a-c7f2-11e8-b410-7831c1c14620",
"category_id":"c1b3bf58-c7f2-11e8-92e7-7831c1c14620",
"mft_part_num":"Smallville Resources Inc 362299XYZ987",
"vendor_part_num":null,
"date_cost_price":null,
"cost_price":"370.000000",
"discount_price":"854.370000",
"list_price":"863.000000",
"cost_usdollar":"370.000000",
"discount_usdollar":"854.370000",
"list_usdollar":"863.000000",
"status":"Available",
"tax_class":"Taxable",
"date_available":"2004-10-15",
"website":null,
"weight":"10.00",
"qty_in_stock":106,
"support_name":null,
"support_description":null,
"support_contact":null,
"support_term":null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefavorites_GET/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.