id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
a875d67be674-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
job_queue_next
Overview
Retrieves the next job from the job queue and marks it as 'In Progress'.
Available APIs
REST
Definition
job_queue_next(session, clientid)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
clientid
String
The client id calling the application. This parameter is of your choosing for the calling application.
Result
Name
Type
Description
result
Array
The call result.
result.results
String
The next job ID.
Change Log
Version
Change
v4
Added job_queue_next method.
Examples
PHP
$job_queue_next_parameters = array(
//Session id
'session' => $session_id,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_next/index.html
|
a875d67be674-1
|
//Session id
'session' => $session_id,
//The ID of the calling application.
'clientid' => 'MyAppID',
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/job_queue_next/index.html
|
65452af8d115-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_module_fields
Overview
Retrieves the list of field vardefs for a specific module.
Available APIs
SOAP
REST
Definition
get_module_fields(session, module_name, fields)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
fields
select_fields | Array
The list of fields to retrieve. An empty parameter will return all.
Result
Name
Type
Description
result
new_module_fields | Array
The call result.
result.module_name
String
The name of the module.
result.table_name
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields/index.html
|
65452af8d115-1
|
String
The name of the module.
result.table_name
String
The name of the modules primary table.
result.module_fields
Array
The vardefs for each individual field.
Change Log
Version
Change
v2
Added fields parameter.
v2
Return type was changed from module_fields to new_module_fields.
Examples
PHP
$get_module_fields_parameters = array(
//Session id
"session" => $session_id,
//The name of the module from which to retrieve fields
'module_name' => "Contacts",
//List of specific fields
'fields' => array(),
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_fields/index.html
|
c829d4d71aaa-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_entries
Overview
Retrieves a list of beans based on specified record IDs.
Available APIs
SOAP
REST
Definition
get_entries(session, module_name, ids, select_fields, link_name_to_fields_array, track_view)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
ids
String
The list of record IDs to retrieve.
select_fields
select_fields | Array
The list of fields to be returned in the results. Specifying an empty array will return all fields.
link_name_to_fields_array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html
|
c829d4d71aaa-1
|
link_name_to_fields_array
link_names_to_fields_array | Array
A list of link names and the fields to be returned for each link.
track_view
Boolean
Flag the record as a recently viewed item.
Result
Name
Type
Description
result
get_entry_result_version2 | Array
The call result.
result.entry_list
Array
The record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.
result.relationship_list
Array
The records link field data.
Change Log
Version
Change
v3_1
Added track_view parameter.
v2
Added link_name_to_fields_array parameter.
v2
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html
|
c829d4d71aaa-2
|
v2
Added link_name_to_fields_array parameter.
v2
Return type was changed from get_entry_result to get_entry_result_version2.
Examples
PHP
$get_entries_parameters = array(
//session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => 'Accounts',
//An array of record IDs
'ids' => array(
'14b0c0ca-3ea2-0ee8-f3be-50aa57c11ee7',
),
//The list of fields to be returned in the results
'select_fields' => array(
'name',
'billing_address_state',
'billing_address_country'
),
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html
|
c829d4d71aaa-3
|
'billing_address_country'
),
//A list of link names and the fields to be returned for each link name
'link_name_to_fields_array' => array(
array(
'name' => 'email_addresses',
'value' => array(
'email_address',
'opt_out',
'primary_address'
),
),
),
//Flag the record as a recently viewed item
'track_view' => true,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entries/index.html
|
6d374c01117b-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
seamless_login
Overview
Verifies that a session is authenticated.
Available APIs
SOAP
REST
Definition
seamless_login(session)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
Result
Name
Type
Description
result
Integer
Returns 1 if the session is authenticated. Otherwise 0 will be returned.
Change Log
Version
Change
Considerations
If you are attempting to log a user into SugarCRM seamlessly, you can do this by passing the validated session_id in the url.
An example is shown below:
http://{site_url}/index.php?module=Home&action=index&MSID={session_id}
Examples
PHP
$seamless_login_parameters = array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/seamless_login/index.html
|
6d374c01117b-1
|
Examples
PHP
$seamless_login_parameters = array(
//Session id
"session" => $session_id,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/seamless_login/index.html
|
f313e99557f3-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_module_layout
Overview
Retrieves the layout metadata for a given module given a specific type and view.
Available APIs
REST
Definition
get_module_layout(session, modules, types, views, acl_check, md5)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
modules
Array
The list of modules to retrieve layouts for.
types
Array
The types of views requested. Current supported types are 'default' (for application) and 'wireless'.
views
Array
The views requested. Current supported types are 'edit', 'detail', 'list', and 'subpanel'.
acl_check
Boolean
Whether or not to check for ACL access.
md5
Boolean
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout/index.html
|
f313e99557f3-1
|
Boolean
Whether or not to check for ACL access.
md5
Boolean
Setting this to true will return an MD5 hash of the modules layouts instead of the layouts themselves.
Result
Name
Type
Description
result
Array
The call result. Contains a list of modules.
result[][$type]
Array
The list of types requested.
result[][$view]
Array or String
The list of layout views requested or MD5 hashes. This is dependent on the 'md5' parameter.
Change Log
Version
Change
v3_1
Added acl_check parameter.
v3
Added get_module_layout method.
Examples
PHP
$get_module_layout_parameters = array(
//Session id
'session' => $session_id,
//The list of modules
'modules' => array(
'Accounts'
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout/index.html
|
f313e99557f3-2
|
'modules' => array(
'Accounts'
),
//The types of views requested
'types' => array(
'default',
),
//The views requested
'views' => array(
'edit'
),
//Whether or not to check for ACL access
'acl_check' => false,
//Whether to return the results as an MD5 hash
'md5' => true,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_module_layout/index.html
|
63e34c7a7082-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_entry_list
Overview
Retrieves a list of beans based on query specifications.
Available APIs
SOAP
REST
Definition
get_entry_list(session, module_name, query, order_by, offset, select_fields, link_name_to_fields_array, max_results, deleted, favorites)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
module_name
String
The name of the module from which to retrieve records. Note: This is the modules key which may not be the same as the modules display name.
query
String
The SQL WHERE clause without the word "where". You should remember to specify the table name for the fields to avoid any ambiguous column errors.
order_by
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html
|
63e34c7a7082-1
|
order_by
String
The SQL ORDER BY clause without the phrase "order by".
offset
Integer
The record offset from which to start.
select_fields
select_fields | Array
The list of fields to be returned in the results. Specifying an empty array will return all fields.
link_name_to_fields_array
link_names_to_fields_array | Array
A list of link names and the fields to be returned for each link.
max_results
Integer
The maximum number of results to return.
deleted
Integer
If deleted records should be included in the results.
favorites
Boolean
If only records marked as favorites should be returned.
Result
Name
Type
Description
result
get_entry_result_version2 | Array
The call result.
result.result_count
Integer
The total number of records returned in the call.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html
|
63e34c7a7082-2
|
result.result_count
Integer
The total number of records returned in the call.
result.total_count
Integer
The total number of records.
resultnext_offset
Integer
The next offset to retrieve records.
result.entry_list
Array
The record's name-value pair for the simple datatypes excluding the link field data. If you do not have access to the object, entry_list[].name_value_list will notify you.
result.relationship_list
Array
The records link field data.
Change Log
Version
Change
v3_1
Added favorites parameter.
v2
Added link_name_to_fields_array parameter.
v2
Return type was changed from get_entry_list_result to get_entry_list_result_version2.
Examples
PHP
$get_entry_list_parameters = array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html
|
63e34c7a7082-3
|
Examples
PHP
$get_entry_list_parameters = array(
//session id
'session' => $session_id,
//The name of the module from which to retrieve records
'module_name' => 'Leads',
//The SQL WHERE clause without the word "where".
'query' => "",
//The SQL ORDER BY clause without the phrase "order by".
'order_by' => "",
//The record offset from which to start.
'offset' => 0,
//A list of fields to include in the results.
'select_fields' => array(
'id',
'name',
'title',
),
//A list of link names and the fields to be returned for each link name.
'link_name_to_fields_array' => array(
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html
|
63e34c7a7082-4
|
'link_name_to_fields_array' => array(
array(
'name' => 'email_addresses',
'value' => array(
'email_address',
'opt_out',
'primary_address'
),
),
),
//The maximum number of results to return.
'max_results' => 2,
//If deleted records should be included in results.
'deleted' => 0,
//If only records marked as favorites should be returned.
'favorites' => false,
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_entry_list/index.html
|
afe1cb88f57b-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
get_report_entries
Overview
Retrieves a list of report entries based on specified record IDs.
Available APIs
SOAP
REST
Definition
get_report_entries(session, ids, select_fields)
Parameters
Name
Type
Description
session
String
Session ID returned by a previous login call.
ids
select_fields | Array
An array of record IDs to retrieve.
select_fields
select_fields | Array
The list of fields to be included in the results.
Result
Name
Type
Description
result
get_entry_result_for_reports | Array
The call result.
result.field_list
Array
The list of selected fields.
result.field_list[].name
String
The name of the report.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_entries/index.html
|
afe1cb88f57b-1
|
result.field_list[].name
String
The name of the report.
result.field_list[].type
String
The type of the report.
result.field_list[].label
String
The label of the report.
result.field_list[].required
Boolean
result.field_list[].options
Array
result.entry_list
Array
The list of report results
result.entry_list[].id
String
The result ID. This is not the record ID.
result.entry_list[].module_name
String
The name of the module. Normally contains the value 'Reports'.
result.entry_list[].name_value_list
Array
The name value list of the report results.
Change Log
Version
Change
v2
Method get_report_entries was added.
Considerations
This method is not available in CE.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_entries/index.html
|
afe1cb88f57b-2
|
Considerations
This method is not available in CE.
Examples
PHP
$get_report_entries_parameters = array(
//Session id
'session' => $session_id,
//An array of record IDs to retrieve.
'ids' => array(
'63f1b905-d206-14cb-cb95-50aa5734815f'
),
//The list of fields to be included in the results.
'select_fields' => array()
);
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/Methods/get_report_entries/index.html
|
198371c2ca92-0
|
This API has been succeeded by a new version. It is recommended to upgrade to the latest API.
SOAP Release Notes
Overview
Lists changes between the different versions of the SOAP API.
Release Notes
v4_1
get_modified_relationships method was added.
get_relationships had the parameter $limit added.
get_relationships had the parameter $offset added.
v4
search_by_module had the parameter $favorites added.
v3_1
get_entries had the parameter $track_view added.
get_entry had the parameter $track_view added.
get_entry_list had the parameter $favorites added.
search_by_module had the parameter $unified_search_only added.
v3
get_available_modules had the parameter $filter added.
get_last_viewed method was added.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-1
|
get_last_viewed method was added.
get_module_fields_md5 method was added.
get_relationships had the parameter $order_by added.
get_upcoming_activities method was added.
search_by_module had the parameter $assigned_user_id added.
search_by_module had the parameter $select_fields added.
v2_1
get_entry_list method logic was modified.
get_report_entries method logic was modified.
v2
contact_by_email method was removed.
create_account method was removed.
create_case method was removed.
create_contact method was removed.
create_lead method was removed.
create_opportunity method was removed.
create_session method was removed.
end_session method was removed.
get_attendee_list method was removed.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-2
|
end_session method was removed.
get_attendee_list method was removed.
get_contact_relationships method was removed.
get_disc_client_file_list method was removed.
get_document_revision return type was changed from return_document_revision to new_return_document_revision.
get_encoded_file method was removed.
get_encoded_portal_zip_file method was removed.
get_encoded_zip_file method was removed.
get_entries had the parameter $link_name_to_fields_array added.
get_entries return type was changed from get_entry_result to get_entry_result_version2.
get_entry had the parameter $link_name_to_fields_array added.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-3
|
get_entry had the parameter $link_name_to_fields_array added.
get_entry return type was changed from get_entry_result to get_entry_result_version2.
get_entry_list had the parameter $link_name_to_fields_array added.
get_entry_list return type was changed from get_entry_list_result to get_entry_list_result_version2.
get_gmt_time method was removed.
get_mailmerge_document method was removed.
get_mailmerge_document2 method was removed.
get_modified_entries method was removed.
get_module_fields had the parameter $fields added.
get_module_fields return type was changed from module_fields to new_module_fields.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-4
|
get_note_attachment return type was changed from return_note_attachment to new_return_note_attachment.
get_quick_sync_data method was removed.
get_related_notes method was removed.
get_relationships had the parameter $link_field_name added.
get_relationships had the parameter $related_fields added.
get_relationships had the parameter $related_module removed.
get_relationships had the parameter $related_module_link_name_to_fields_array added.
get_relationships return type was changed from get_relationships_result to get_entry_result_version2.
get_report_entries method was added.
get_required_upgrades method was removed.
get_server_info method was added.
get_server_time method was removed.
get_server_version method was removed.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-5
|
get_server_time method was removed.
get_server_version method was removed.
get_sugar_flavor method was removed.
get_system_status method was removed.
get_unique_system_id method was removed.
is_loopback method was removed.
is_user_admin method was removed.
login had the parameter $name_value_list added.
login return type was changed from set_entry_result to entry_value.
logout return type was changed from error_value to void.
offline_client_available method was removed.
relate_note_to_module method was removed.
search method was removed.
search_by_module had the parameter $password removed.
search_by_module had the parameter $session added.
search_by_module had the parameter $user_name removed.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-6
|
search_by_module had the parameter $user_name removed.
search_by_module return type was changed from get_entry_list_result to return_search_result.
set_campaign_merge return type was changed from error_value to void.
set_document_revision return type was changed from set_entry_result to new_set_entry_result.
set_entries return type was changed from set_entries_result to new_set_entries_result.
set_entries_details method was removed.
set_entry return type was changed from set_entry_result to new_set_entry_result.
set_note_attachment had the parameter $note type change from note_attachment to new_note_attachment.
set_note_attachment return type was changed from set_entry_result to new_set_entry_result.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-7
|
set_relationship had the parameter $delete added.
set_relationship had the parameter $link_field_name added.
set_relationship had the parameter $module_id added.
set_relationship had the parameter $module_name added.
set_relationship had the parameter $name_value_list added.
set_relationship had the parameter $related_ids added.
set_relationship had the parameter $set_relationship_value removed.
set_relationship return type was changed from error_value to new_set_relationship_list_result.
set_relationships had the parameter $delete_array added.
set_relationships had the parameter $link_field_names added.
set_relationships had the parameter $module_ids added.
set_relationships had the parameter $module_names added.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
198371c2ca92-8
|
set_relationships had the parameter $module_names added.
set_relationships had the parameter $name_value_lists added.
set_relationships had the parameter $related_ids added.
set_relationships had the parameter $set_relationship_list removed.
set_relationships return type was changed from set_relationship_list_result to new_set_relationship_list_result.
sudo_user method was removed.
sync_get_entries method was removed.
sync_get_modified_relationships method was removed.
sync_get_relationships method was removed.
sync_set_entries method was removed.
sync_set_relationships method was removed.
track_email method was removed.
update_portal_user method was removed.
user_list method was removed.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/Legacy_API/SOAP_Release_Notes/index.html
|
6c6581913828-0
|
REST API
Overview
v10 - v11.20 API documentation.
What Is REST?
REST stands for 'Representational State Transfer'. As of 7.x, REST is a core component of Sugar that defines how all information is exchanged within the application. The v10+ API is separate from the v1 - v4_1 REST APIs in that it has been rebuilt with the latest REST standards. Most functionality in the system, whether fetching or posting data, is interacting with the API in some way.
Getting Started
How to Access the REST Service
The base endpoint for the REST service can be found at https://<site_url>/rest/v{version}/.
Note: version refers to the version of the APIÂ you are accessing.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-1
|
Note: version refers to the version of the APIÂ you are accessing.
For your reference, the help documentation for all versioned endpoints can be found by navigating to https://<site_url>/rest/v{version}/help. Once you have identified your instance's base endpoint, we can begin by authenticating.
Authentication
Sugar uses two-legged OAuth2 for authentication. You simply need to do a POST to /rest/<version>/oauth2/token with the following parameters:
grant_type
String
Type of request. Available grant types are "password" and "refresh_token".
client_id
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-2
|
client_id
String
The client_id of "sugar" will automatically create an OAuth Key in the system and can be used for "password" authentication. The client_id of "support_portal" will create an OAuth Key if the portal system is enabled and will allow for portal authentication. Other client_id's can be created by the administrator in the OAuthKeys section in the Administration section and can be used in the future for additional grant types, if the client secret is filled in, it will be checked to validate the use of the client id.
client_secret
String
The client's secret key.
username
String
The username of the user authenticating to the system.
password
String
The plaintext password the user authenticating to the system.
platform
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-3
|
String
The plaintext password the user authenticating to the system.
platform
String
Defaults to "base" allows you to have custom meta-data per platform. If using a value other than "base", you should make sure it is registered using the Platform extension or configure an API platform in Administration panel.
First, we are going to log in using a grant_type of "password" and a platform of "custom". Normally, when logging into Sugar, users log in with a platform type of "base". We are using "custom" to avoid any potential login conflicts.
curl -X POST -H Cache-Control:no-cache -H "Content-Type: application/json" -d '{
"grant_type":"password",
"client_id":"sugar",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-4
|
"client_id":"sugar",
"client_secret":"",
"username":"<username>",
"password":"<password>",
"platform":"custom"
}' https:/<site_url>/rest/<version>/oauth2/token
Once you get the response you will need to hold onto the access_token and the refresh_token. Anytime the access_token is invalidated, you will want to make another request to the token endpoint with a grant_type of "refresh_token". Store just the refresh_token in long-term storage â not the username and password. The response from the server will be as follows:
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-5
|
{
"access_token": "5ee48ec7-023e-ecff-5184-530bd0358868",
"expires_in": 3600,
"token_type": "bearer",
"scope": null,
"refresh_token": "5f197357-0167-f7a6-7912-530bd03275b6",
"refresh_expires_in": 1209600,
"download_token": "5f531625-e301-e3ea-1b11-530bd098be41"
}
Avoiding Login Conflicts
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-6
|
}
Avoiding Login Conflicts
Login conflicts often occur when building integrations or running data migrations with the platform of "base" or any other client type that is in use. This is due to the fact that Sugar uses the same REST API to power all the various clients such as Sugar, Portal, Mobile, and even the Outlook Plugin. Due to this, you need to let the API know you aren't conflicting with another client that may be in use. The way to accomplish this is the /rest/<version>/oauth2/token call by changing the platform parameter to something other than "base", "mobile", or "portal". It is best to name it something that describes and identifies your current integration.
Input / Output Data Types
The default input / output datatype for REST is JSON.
Date Handling
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-7
|
The default input / output datatype for REST is JSON.
Date Handling
Date and date time inputs should be formatted following the ISO 8601 format. If the time zone is not included in a request, Sugar will assume the time zone of the user making the request.
Filter on a specific date:
{
"date_start": "2015-08-12"
}
Filter on a date keyword using $dateRange:
{
"date_start": {
"$dateRange": "today"
}
}
Filter on date range using manual time zones:
{
"date_start": {
"$dateBetween": [
"2015-09-10T00:00:00+10:00",
"2015-09-10T23:59:59+10:00"
]
}
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
6c6581913828-8
|
]
}
}
TopicsEndpointsThe following sections contain the in-app help documentation for the REST endpoints.Extending EndpointsHow to add your own custom endpoints to the REST API.API ExceptionsSugar comes with some predefined API Exceptions, located in ./include/api/, that can be called from API endpoints. These exceptions return a specific HTTP code and a message.
Last modified: 2023-04-05 00:08:11
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/index.html
|
34a3edbfe6a1-0
|
API Exceptions
Overview
Sugar comes with some predefined API Exceptions, located in ./include/api/, that can be called from API endpoints. These exceptions return a specific HTTP code and a message.
Stock Exceptions
Exception Class
HTTP Code
Error Label
Language Label Key
Language Label Value
SugarApiExceptionError
500Â
fatal_errorÂ
EXCEPTION_FATAL_ERRORÂ
Your request failed to complete. A fatal error occurred. Check logs for more details.
SugarApiExceptionIncorrectVersion
301
incorrect_version
EXCEPTION_INCORRECT_VERSIONÂ
The version of the API you are using is not correct for the current request.
SugarApiExceptionNeedLogin
401
need_login
EXCEPTION_NEED_LOGINÂ
You need to be logged in to perform this action.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-1
|
You need to be logged in to perform this action.
SugarApiExceptionInvalidGrant
401
invalid_grant
EXCEPTION_INVALID_TOKENÂ
Your authentication token is invalid.
SugarApiExceptionNotAuthorized
403
not_authorized
EXCEPTION_NOT_AUTHORIZED
You are not authorized to perform this action. Contact your administrator if you need access.
SugarApiExceptionPortalUserInactive
403
inactive_portal_user
EXCEPTION_INACTIVE_PORTAL_USERÂ
You cannot access Portal because your portal account is inactive. Please contact customer support if you need access.
SugarApiExceptionPortalNotConfigured
403
portal_not_configured
EXCEPTION_PORTAL_NOT_CONFIGUREDÂ
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-2
|
EXCEPTION_PORTAL_NOT_CONFIGUREDÂ
Portal is not configured properly. Contact your Portal Administrator for assistance.
SugarApiExceptionNoMethod
404
no_method
EXCEPTION_NO_METHODÂ
Your request was not supported. Could not find the HTTP method of your request for this path.
SugarApiExceptionNotFound
404
not_found
EXCEPTION_NOT_FOUNDÂ
Your requested resource was not found. Could not find a handler for the path specified in the request.
SugarApiExceptionEditConflict
409
edit_conflict
EXCEPTION_EDIT_CONFLICTÂ
Edit conflict, please reload the record data.
SugarApiExceptionInvalidHash
412
metadata_out_of_date
EXCEPTION_METADATA_OUT_OF_DATE
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-3
|
EXCEPTION_METADATA_OUT_OF_DATE
Your metadata or user hash did not match the server. Please resync your metadata.
SugarApiExceptionRequestTooLarge
413
request_too_large
EXCEPTION_REQUEST_TOO_LARGE
Your request is too large to process.
SugarApiExceptionMissingParameter
422
missing_parameter
EXCEPTION_MISSING_PARAMTER
A required parameter in your request was missing.
SugarApiExceptionInvalidParameter
422
invalid_parameter
EXCEPTION_INVALID_PARAMETER
A parameter in your request was invalid.
SugarApiExceptionRequestMethodFailure
424
request_failure
EXCEPTION_REQUEST_FAILURE
Your request failed to complete.
SugarApiExceptionClientOutdated
433
client_outdated
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-4
|
SugarApiExceptionClientOutdated
433
client_outdated
EXCEPTION_CLIENT_OUTDATED
Your software is out of date, please update your client before attempting to connect again.
SugarApiExceptionConnectorResponse
502
bad_gateway
EXCEPTION_CONNECTOR_RESPONSE
A connector or an integration request resulted in a failed response.
SugarApiExceptionMaintenance
503
maintenance
EXCEPTION_MAINTENANCE
SugarCRM is in maintenance mode. Only admins can login. Please contact your administrator for details.
SugarApiExceptionServiceUnavailable
503
service_unavailable
EXCEPTION_SERVICE_UNAVAILABLE
The server cannot process your request because it is busy or unavailable at this time.
SugarApiExceptionSearchUnavailable
400
search_unavailable
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-5
|
SugarApiExceptionSearchUnavailable
400
search_unavailable
EXCEPTION_SEARCH_UNAVAILABLE
Search engine is temporarily unavailable.
SugarApiExceptionSearchRuntime
400
search_runtime
EXCEPTION_SEARCH_RUNTIMEÂ
A search engine runtime error occurred. Please contact your System Administrator.
Using Exceptions
When extending endpoints in Sugar, the stock API exceptions can be used to return errors and messages. The exception classes accept a single parameter on creation for the message value to return. This parameter can accept language label keys or plain text. If no parameter is passed exception, the error will default to the exception's default language label key. To call a stock API exception from custom code add the following snippet :
//throwing an api exception using the stock message
throw new SugarApiExceptionError();
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-6
|
throw new SugarApiExceptionError();
//throwing an api exception using a custom language label key
throw new SugarApiExceptionError('EXCEPTION_CSTM_LABEL_KEY');
//throwing an api exception with text
throw new SugarApiExceptionError('There has been an error.');
This will return an http response code of 500 with the following response data:
{
"error": "fatal_error",
"error_message": "There has been an error."
}
Custom Exceptions
Sugar gives you the ability to create custom API exceptions by creating a new class in ./custom/include/api/ that extends the stock SugarApiException class. When extending the class you can provide the following properties in your custom code:
$httpCode
The http response code to send back in the header. Defaults to 400 if not specified.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-7
|
The http response code to send back in the header. Defaults to 400 if not specified.
$errorLabel
The string value returned in the 'error' key response.
$messageLabel
The label to return as a default response if a message is not provided.
Example
The following example will demonstrate how to create a custom exception.
./custom/include/api/<name>.php
<?php
require_once 'include/api/SugarApiException.php';
/**
* Custom error.
*/
class cstmSugarApiExceptionError extends SugarApiException
{
public $httpCode = 404;
public $errorLabel = 'my_error';
public $messageLabel = 'EXCEPTION_CSTM_LABEL_KEY';
}
Create a custom language label using the extension framework:
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-8
|
}
Create a custom language label using the extension framework:
./custom/Extension/application/Ext/Language/<name>.php
<?php
$app_strings['EXCEPTION_CSTM_LABEL_KEY'] = 'My Exception Message.';
You can call your new exception by using the following code :Â
require_once 'custom/include/api/<name>.php';
//throwing custom api exception using the default message
throw new cstmSugarApiExceptionError();
//throwing custom api exception using a custom language label key
throw new cstmSugarApiExceptionError('EXCEPTION_CSTM_LABEL_KEY');
//throwing custom api exception with text
throw new cstmSugarApiExceptionError('There has been an error.');
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/API_Exceptions/index.html
|
34a3edbfe6a1-9
|
throw new cstmSugarApiExceptionError('There has been an error.');
You will then need to navigate to Admin > Repair > Quick Repair and Rebuild before using your exception.
The exception error will return a response of:Â
{
"error": "my_error",
"error_message": "There has been an error."
}
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/API_Exceptions/index.html
|
90580c61aff5-0
|
Endpoints
The following sections contain the in-app help documentation for the REST endpoints.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-1
|
Topics/Accounts/:record/link/:link_name/filter GETLists related filtered records./Activities GETActivities on the home page/Activities/filter GETActivities on the home page/Administration/aws GET[ADMIN] Gets Amazon Web Services configs from Sugar Serve./Administration/aws POST[ADMIN] Set Amazon Web Services configs in Sugar Serve./Administration/config/:category GET[ADMIN] Get Configuration Settings for a Category./Administration/config/:category POST[ADMIN] Set Configuration Settings for a Category./Administration/elasticsearch/indices GET[ADMIN] Elasticsearch index statistics/Administration/elasticsearch/mapping GET[ADMIN] Elasticsearch mapping/Administration/elasticsearch/queue GET[ADMIN] Elasticsearch queue statistics/Administration/elasticsearch/refresh/enable POST[ADMIN] Elasticsearch enable
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-2
|
POST[ADMIN] Elasticsearch enable refresh_interval/Administration/elasticsearch/refresh/status GET[ADMIN] Elasticsearch index refresh interval status/Administration/elasticsearch/refresh/trigger POST[ADMIN] Elasticsearch trigger explicit index refresh on all indices/Administration/elasticsearch/replicas/enable POST[ADMIN] Elasticsearch enable replicas/Administration/elasticsearch/replicas/status GET[ADMIN] Elasticsearch index replica status/Administration/elasticsearch/routing GET[ADMIN] Elasticsearch index routing/Administration/idm/migration/disable POST[ADMIN] Disable Idm migrations/Administration/idm/migration/enable POST[ADMIN] Enable Idm migrations/Administration/idm/users GETLists filtered user records./Administration/license/limits GET[ADMIN] Get License Limits./Administration/packages
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-3
|
GET[ADMIN] Get License Limits./Administration/packages GET[ADMIN] PackageManager list packages./Administration/packages POST[ADMIN] PackageManager upload package./Administration/packages/:file_install/install GET[ADMIN] PackageManager install a package./Administration/packages/:id/disable GET[ADMIN] PackageManager disable a package./Administration/packages/:id/enable GET[ADMIN] PackageManager enable a package./Administration/packages/:id/uninstall GET[ADMIN] PackageManager uninstall a package./Administration/packages/installed GET[ADMIN] PackageManager lists installed packages./Administration/packages/staged GET[ADMIN] PackageManager lists staged packages./Administration/packages/:unFile DELETE[ADMIN] PackageManager delete a package./Administration/portalmodules GET[ADMIN] Gets an array of modules currently enabled for Sugar
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-4
|
GET[ADMIN] Gets an array of modules currently enabled for Sugar Portal./Administration/search/fields GET[ADMIN] Search field configuration/Administration/search/reindex POST[ADMIN] Search schedule reindex/Administration/search/status GET[ADMIN] Search status/Administration/settings/auth GET[ADMIN] Fetch auth settings./Administration/settings/idmMode DELETE[ADMIN] Turn IDM-mode off./Administration/settings/idmMode POST[ADMIN] Turn IDM-mode on./Calendar/invitee_search GETTemporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead./Calls POSTCreate a single event or a series of event records./Calls/:record DELETEDeletes either a single event record or a series of event records/Calls/:record PUTUpdate a calendar event
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-5
|
event record or a series of event records/Calls/:record PUTUpdate a calendar event record of the specified type./Cases/clients/portal PUT[ADMIN] Set a case as 'Requested For Close'/CommentLog/:record GETRetrieves a record./ConsoleConfiguration/config POSTSaves configuration changes in the database./ConsoleConfiguration/default-metadata GETGets the request metadata in JSON format./Contact/:record/Cases GETGet a contact's related cases, filtered by an expression, which are accessible to a contact with portal visibility./Contacts/:record/freebusy GETGet a contact's FreeBusy schedule/Currencies GETReturns a collection of Currency models/Dashboards/Activities GETList current user's filtered Activity Stream dashboards./Dashboards GETList current user's filtered Home dashboards./Dashboards POSTCreate a new Home dashboard./Dashboards/:id/restore-metadata
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-6
|
POSTCreate a new Home dashboard./Dashboards/:id/restore-metadata PUTRestores the metadata for a module's dashboard to the default metadata./Dashboards/<module> GETList current user's filtered dashboards./Dashboards/<module> POSTCreate a new dashboard./DataArchiver/:id/run POST[ADMIN] Performs the archiving process./Documents/:record/file/:field POSTAttaches a file to a field on a record./Documents/:record/file/:field PUTThis 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/EmailAddresses POSTCreate
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-7
|
sent with the request to assign a name. Additionally, the PUT/EmailAddresses POSTCreate a new email address./EmailAddresses/:record PUTUpdate an existing email address./Emails GETLists filtered emails./Emails POSTCreate a new Emails record./Emails/count GETLists filtered emails./Emails/filter GETLists filtered emails./Emails/filter POSTLists filtered records./Emails/filter/count GETLists filtered records./Emails/filter/count POSTLists filtered records./Emails/:record GETRetrieves an Emails record./Emails/:record PUTUpdate an existing Emails record./Emails/:record/link POSTCreates a relationship to a pre-existing email./Emails/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to a pre-existing email from a record
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-8
|
POSTCreates relationships to a pre-existing email from a record list./Emails/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between an email and another record./Emails/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing email./EmbeddedFiles/:record/file/:field GETRetrieves an attached file for a specific field on a record./EmbeddedFiles/:record/file/:field POSTAttaches a file to a field on a record./EmbeddedFiles/:record/file/:field PUTThis 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,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-9
|
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/Employees GETLists filtered records./ExpressionEngine/:record/related GETRetrieve a Forecasting Information In SugarChart Format/ExpressionEngine/:record/related POSTRetrieve a Forecasting Information In SugarChart Format/Filters GETLists filtered records./ForecastManagerWorksheets GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/assignQuota POSTAssign Quotas to All Reporting Users for a given timeperiod/ForecastManagerWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastManagerWorksheets/filter GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/filter POSTReturns a collection of
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-10
|
ForecastManagerWorksheet models/ForecastManagerWorksheets/filter POSTReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id GETReturns a collection of ForecastManagerWorksheet models/ForecastManagerWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastManagerWorksheet models/ForecastWorksheets GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/export GETReturns a record set in CSV format along with HTTP headers to indicate content type./ForecastWorksheets/filter GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/filter POSTReturns a collection of ForecastWorksheet models/ForecastWorksheets/:record PUTSaves a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id GETReturns a collection of ForecastWorksheet
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-11
|
GETReturns a collection of ForecastWorksheet models/ForecastWorksheets/:timeperiod_id/:user_id GETReturns a collection of ForecastWorksheet models/Forecasts GETUpdates a record of a specified type as a favorite for the current user./Forecasts/config POSTCreates and/or updates the config settings for the Forecasts module/Forecasts/config PUTCreates and/or updates the config settings for the Forecasts module/Forecasts/enum/selectedTimePeriod GETForecastsApi Timeperiod filter info/Forecasts/init GETThis endpoint is used to return initialization data for the Forecasts module./Forecasts/reportees/:user_id GETForecastsApi Reportees/Forecasts/:timeperiod_id/progressManager/:user_id GETProjected Manager Data/Forecasts/:timeperiod_id/progressRep/:user_id GETThis endpoint is used to return the
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-12
|
GETThis endpoint is used to return the json Data not already in client view for the Forecasts rep projected panel./Forecasts/:timeperiod_id/quotas/direct/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/quotas/rollup/:user_id GETForecastsQuotasApi - Get/Forecasts/:timeperiod_id/:user_id/chart/:display_manager GETRetrieve a Forecasting Information In SugarChart Format/Forecasts/user/:user_id GETThis endpoint is used to return a user's id, user_name, full_name, first_name, last_name, and is_manager param given a user's id./Genericsearch GETThis endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-13
|
by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic"./Genericsearch POSTThis endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic"./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value DELETERemoves a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-14
|
and those records are related, then remove the relationship of the RHS record to the LHS record./integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POSTCreates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PATCHSets a sync key value for a
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-15
|
PATCHSets a sync key value for a record./integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUTSets a sync key value for a record. Note that the PATCH method is recommended over the PUT method./integrate/<module>/:sync_key_field_name/:sync_key_field_value DELETEDeletes the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value GETRetrieves the record with the given sync_key_field_name./integrate/<module>/:sync_key_field_name/:sync_key_field_value PATCHUpserts based on sync_key_field_name. If a record can be found with
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-16
|
based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it./integrate/<module>/:sync_key_field_name/:sync_key_field_value PUTUpserts based on sync_key_field_name. If a record can be found with sync_key_field_name, then update. If the record does not exist, then create it. Note that the PATCH method is recommended over the PUT method./KBContents GETLists filtered records./KBContents/config POSTCreates and/or updates the config settings for the KBContents module/KBContents/config PUTCreates and/or updates the config settings for the KBContents module/KBContents/duplicateCheck POSTRuns a duplicate check against specified
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-17
|
module/KBContents/duplicateCheck POSTRuns a duplicate check against specified data./KBContents/filter GETLists filtered records./KBContents/:record/link POSTCreates relationships to a pre-existing record./KBContents/:record/notuseful PUTVote for Knowledge Base article./KBContents/:record/useful PUTVote for Knowledge Base article./Leads POSTCreate Lead with optional post-save actions/Leads/:leadId/convert POSTConvert Lead to a Contact and optionally link it to a new or existing instance of the modules specified/Leads/:record/freebusy GETGet a lead's FreeBusy schedule/Leads/register POSTCreates new Leads./Mail POSTCreate an email and send or save as draft./Mail/address/validate POSTValidate one or more email addresses./Mail/archive POSTArchives an
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-18
|
POSTValidate one or more email addresses./Mail/archive POSTArchives an email./Mail/attachment POSTUpload an email attachment/Mail/attachment/cache DELETEClears the user's attachment cache directory/Mail/attachment/:file_guid DELETEDelete an updated email attachment (where :file_guid is the guid value returned from the /Mail/attachment API)/Mail/recipients/find GETFinds recipients that match the search term./Mail/recipients/lookup POSTAccepts an array of one or more recipients and tries to resolve unsupplied arguments to provide more comprehensive/Meetings POSTCreate a single event or a series of event records./Meetings/:record DELETEDeletes either a single event record or a series of event records/Meetings/:record PUTUpdate a calendar event record of the specified type./Meetings/:record/external GETRetrieves info about
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-19
|
event record of the specified type./Meetings/:record/external GETRetrieves info about launching an external meeting/Notifications GETLists filtered records./Opportunities/config POSTOpportunity Config Save/Opportunities/enum/:field GETRetrieves the enum values for a specific field./Opportunities/:record PUTUpdate a record of the specified type./OutboundEmailConfiguration/list GETLists the current user's outbound email configurations for sending email./OutboundEmail POSTCreate a new OutboundEmail configuration to use to send emails over SMTP./OutboundEmail/:record PUTUpdate an OutboundEmail configuration./PdfManager GETLists filtered records./PdfManager/generate GETPdfManager Generate Endpoint Help/ProductTemplates/tree GETThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/ProductTemplates/tree POSTThis endpoint is designed
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-20
|
one level of product templates and product categories in/ProductTemplates/tree POSTThis endpoint is designed to return a paged recordset of one level of product templates and product categories in/Quotes/config GETQuote Config GET Help/Quotes/config POSTQuote Config POST Help/Quotes/:record/opportunity POSTQuote Convert to Opportunity/Reports/:record/chart GETAn API to get chart data for a saved report./Reports/:record/record_count GETAn API to get total number of filtered records from a saved report./Reports/:record/records GETAn API to deliver filtered records from a saved report./Reports/:record/:type GETAn API to run a saved report and export the result./RevenueLineItems/multi-quote POSTConvert Multiple Revenue Line Item to a quote./RevenueLineItems/:record/quote POSTConvert a Revenue Line Item to a quote./Tags/:record PUTUpdate a record of the
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-21
|
a Revenue Line Item to a quote./Tags/:record PUTUpdate a record of the specified type./Teams/:record/link POSTCreates relationships to a pre-existing record./Teams/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Teams/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./TimePeriods GETLists filtered records./TimePeriods/current GETGet the get the current timeperiod/TimePeriods/:date GETReturn a Timeperiod by a given date/TimePeriods/filter GETLists filtered records./Users GETLists filtered records./Users/:record DELETEDelete a User and return its ID/Users/:record/freebusy GETGet a user's FreeBusy schedule/Users/:record/link
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-22
|
GETGet a user's FreeBusy schedule/Users/:record/link POSTCreates relationships to a pre-existing record./Users/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./Users/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./VCardDownload GETDownloads a vCard./bulk POSTRun API calls in bulk./collection/:collection_name GETLists records from multiple modules at a time./connectors GETGets general info about connectors./connector/twitter/currentUser GETResponds with twitter timeline if connector is set up in administration/connector/twitter/:twitterId GETResponds with twitter timeline if connector is set up in administration/css GETRuns LessPHP for a platform and a theme and outputs an array of css files. If not found the css
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-23
|
a platform and a theme and outputs an array of css files. If not found the css files/css/preview GETRuns LessPHP for a platform and a theme and outputs the compiled CSS. It only allows to preview the theme because/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/help GETFetches the help documentation/help/exceptions GETFetches the documentation on which exceptions are thrown by the API, their/lang/labels/dropdown PUTUpdate display labels of dropdown items for dropdowns under different languages./lang/labels/module PUTUpdate display labels of fields for modules under different languages./logger POSTLogs a message to the Sugar Log/login/content GETReturns information to facilitate receiving marketing content from
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-24
|
a message to the Sugar Log/login/content GETReturns information to facilitate receiving marketing content from SugarCRM./login/marketingContentUrl GETReturns the SugarCRM marketing content URL that is managed by the marketing team./me GETReturns the current user object./me PUTReturns the current user object./me/following GETReturns all of the current users followed records/me/password POSTCreate a new record of a specified type./me/password PUTCreate a new record of a specified type./me/preference/:preference_name DELETEDeletes a specific preference for the current user./me/preference/:preference_name GETReturns a specific preference for the current user./me/preference/:preference_name POSTCreates a preference for the current user./me/preference/:preference_name PUTUpdates a specific preference for the current user./me/preferences GETReturns all the current
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-25
|
a specific preference for the current user./me/preferences GETReturns all the current user's stored preferences./me/preferences PUTMass updates preferences for the user./metadata/<module>/:segment GET[ADMIN] Gets the desired segment for a given module./<module>/Activities GETActivities on a module's list view/<module>/Activities/filter GETActivities on a module's list view/<module>/MassUpdate DELETEAn API to mass delete records./<module>/MassUpdate PUTAn API to mass update records./<module> GETLists filtered records./<module> POSTCreate a new record of a specified type./<module>/append/:target POSTAppend new node to target node as last child./<module>/audit/export GETReturns a list of data changes for a specific module./<module>/config GETRetrieves the config settings for
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-26
|
data changes for a specific module./<module>/config GETRetrieves the config settings for a given module./<module>/config POSTRetrieves the config settings for a given module./<module>/config PUTRetrieves the config settings for a given module./<module>/count GETLists filtered records./<module>/customfield POSTCreate a new custom field for a specified module./<module>/customfield/:field DELETEDelete a custom field for a specified module./<module>/duplicateCheck POSTRuns a duplicate check against specified data./<module>/enum/:field GETRetrieves the enum values for a specific field./<module>/export/:record_list_id GETReturns a record set in CSV format along with HTTP headers to indicate content type./<module>/favorites GETOpportunity Favorites Help/<module>/favorites
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-27
|
GETOpportunity Favorites Help/<module>/favorites POSTOpportunity Favorites Help/<module>/file/vcard_import POSTImports a person record from a vcard./<module>/filter GETLists filtered records./<module>/filter POSTLists filtered records./<module>/filter/count GETLists filtered records./<module>/filter/count POSTLists filtered records./<module>/globalsearch GETThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/globalsearch POSTThis endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the/<module>/insertafter/:target POSTInsert new node after target node./<module>/insertbefore/:target POSTInsert new node before target
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-28
|
node after target node./<module>/insertbefore/:target POSTInsert new node before target node./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value DELETERemoves a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, and those records are related, then remove the relationship of the RHS record to the LHS record./<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POSTCreates a relationship based on sync_key. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-29
|
records can be found with the respective fields, then relate the RHS record to the LHS record./<module>/prepend/:target POSTAppend new node to target node as first child./<module>/recent-product GETOpportunity Recent Product Help/<module>/recent-product POSTOpportunity Recent Product Help/<module>/:record DELETEDelete a record of a specified type./<module>/:record GETRetrieves a record./<module>/:record PUTUpdate a record of the specified type./<module>/record_list POSTAn API to create and save lists of records./<module>/record_list/:record_list_id DELETEAn API to delete lists of records/<module>/record_list/:record_list_id GETAn API to return record list data/<module>/:record/audit GETReturns data changes for a
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-30
|
return record list data/<module>/:record/audit GETReturns data changes for a specific record./<module>/:record/children GETRetrieves all children of selected record./<module>/:record/collection/:collection_name GETLists related records from multiple links at a time./<module>/:record/collection/:collection_name/count GETCounts related records from multiple links at a time./<module>/:record/favorite DELETERemoves a record of a specified type as a favorite for the current user./<module>/:record/favorite PUTUpdates a record of a specified type as a favorite for the current user./<module>/:record/file GETLists all populated fields of type "file" or of type "image" for a record./<module>/:record/file/:field DELETERemoves an attachment from a field for a record and
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-31
|
DELETERemoves an attachment from a field for a record and subsequently removes the file from the file system./<module>/:record/file/:field GETRetrieves an attached file for a specific field on a record./<module>/:record/file/:field POSTAttaches a file to a field on a record./<module>/:record/file/:field PUTThis 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/<module>/:record/link POSTCreates relationships to a pre-existing record./<module>/:record/link/activities
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-32
|
relationships to a pre-existing record./<module>/:record/link/activities GETActivities on a module's list view/<module>/:record/link/activities/filter GETActivities on a module's list view/<module>/:record/link/history GETLists history filtered records./<module>/:record/link/:link_name GETLists related filtered records./<module>/:record/link/:link_name POSTCreates a related record./<module>/:record/link/:link_name/add_record_list/:remote_id POSTCreates relationships to pre-existing record from a record list./<module>/:record/link/:link_name/count GETLists related filtered records./<module>/:record/link/:link_name/filter GETLists related filtered
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-33
|
GETLists related filtered records./<module>/:record/link/:link_name/filter/count GETLists related filtered records./<module>/:record/link/:link_name/filter/leancount GETLists related filtered records./<module>/:record/link/:link_name/leancount GETLists related filtered records./<module>/:record/link/:link_name/:remote_id DELETEDeletes an existing relationship between two records./<module>/:record/link/:link_name/:remote_id GETRetrieves a related record with relationship role information./<module>/:record/link/:link_name/:remote_id POSTCreates a relationship to a pre-existing record./<module>/:record/link/:link_name/:remote_id PUTUpdates relationship specific information on an existing
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-34
|
PUTUpdates relationship specific information on an existing relationship./<module>/:record/link/related_activities GETReturns related activity records for a specified record./<module>/:record/moveafter/:target PUTMove existing node after target node./<module>/:record/movebefore/:target PUTMove existing node before target node./<module>/:record/movefirst/:target PUTMove existing node as first child of target node./<module>/:record/movelast/:target PUTMove existing node as last child of target node./<module>/:record/next GETRetrieves next sibling of selected record./<module>/:record/parent GETRetrieves parent node for selected record./<module>/:record/path GETRetrieves all parents of selected record./<module>/:record/pii GETReturns personally identifiable information (pii) fields with
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-35
|
GETReturns personally identifiable information (pii) fields with current data and source of data capture for a specific record./<module>/:record/prev GETRetrieves previous sibling of selected record./<module>/:record/subscribe POSTThis endpoint creates a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be subscribed to activity stream messages for the record being subscribed to, or "followed"./<module>/:record/unfavorite PUTRemoves a record of a specified type as a favorite for the current user./<module>/:record/unsubscribe DELETEThis endpoint deletes a subscription record in the Subscriptions table, from a specified record and module. It allows the user to be unsubscribe from activity stream messages for the record being subscribed to, or "followed"./<module>/:record/vcard GETDownloads a
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-36
|
or "followed"./<module>/:record/vcard GETDownloads a vCard./<module>/:root/tree GETRetrieves full tree for selected root record./<module>/sync_key/:sync_key_field_value DELETEDeletes the record with the given sync_key./<module>/sync_key/:sync_key_field_value GETRetrieves the record with the given sync_key./<module>/sync_key/:sync_key_field_value PATCHUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not exist, then create it./<module>/sync_key/:sync_key_field_value PUTUpserts based on sync_key. If a record can be found with sync_key, then update. If the record does not
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-37
|
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./<module>/temp/file/:field POSTSaves an image to a temporary folder./<module>/temp/file/:field/:temp_id GETReads a temporary image and deletes it./mostactiveusers GETFetches the most active users for meetings, calls, inbound emails, and outbound emails./oauth2/bwc/login POSTATTENTION: FOR INTERNAL USAGE ONLY/oauth2/logout POSTExpires the token portion of the OAuth 2.0 specification./oauth2/sudo/:user_name POSTGet an access token as another user. The current user must be an admin in order to access this endpoint. This method is useful for integrations in order to be able to access the
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-38
|
to access this endpoint. This method is useful for integrations in order to be able to access the system with the same permission restrictions as a specified user. The calling user does not lose their existing token, this one is granted in addition./oauth2/token POSTRetrieves the token portion of the OAuth 2.0 specification./password/request GETSends an email request to reset a users password./ping GETResponds with "pong" if the access_token is valid./ping/whattimeisit GETResponds with the current time in server format./pmse_Business_Rules GETLists filtered records./pmse_Business_Rules/file/businessrules_import POSTImports a Process Business Rules definition from a .pbr file/pmse_Business_Rules/:record/brules GETExports a .pbr file with a Process Business Rules definition/pmse_Emails_Templates GETLists filtered
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-39
|
file with a Process Business Rules definition/pmse_Emails_Templates GETLists filtered records./pmse_Emails_Templates/file/emailtemplates_import POSTImports a Process Email Templates definition from a .pet file/pmse_Emails_Templates/:/find_modules GETGet the related module list for a module/pmse_Emails_Templates/:record/etemplate GETExports a .pet file with a Process Email Templates definition/pmse_Emails_Templates/variables/find GETGet the variable list for a module/pmse_Inbox/AdhocReassign PUTDeprecated endpoint./pmse_Inbox/AdhocReassign/:data/:flowId GETDeprecated endpoint./pmse_Inbox/ReassignForm PUTDeprecated
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-40
|
GETDeprecated endpoint./pmse_Inbox/ReassignForm PUTDeprecated endpoint./pmse_Inbox/ReassignForm/:data/:flowId GETDeprecated endpoint./pmse_Inbox GETReturns a list of Processes by user using filters/pmse_Inbox/cancelCases PUTCall methods to cancel a process/pmse_Inbox/case/:id/:idflow GETRetrieve information of the process record/pmse_Inbox/casesList GETReturns a list with the processes for Process Management/pmse_Inbox/changeCaseUser/:cas_id GETDeprecated endpoint./pmse_Inbox/clearLog/:typelog PUTClear the PMSE.log file log/pmse_Inbox/delete_notes/:id DELETEDeletes a process note/pmse_Inbox/engine_claim PUTClaims the processes
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-41
|
a process note/pmse_Inbox/engine_claim PUTClaims the processes to the current user/pmse_Inbox/engine_route PUTEvaluates the response of the user form Show Process [Approve, Reject, Route]/pmse_Inbox/filter GETReturns a list of Processes by user/pmse_Inbox/getLog GETReturn the text of the PMSE.log file/pmse_Inbox/historyLog/:filter GETGets the history log for a process/pmse_Inbox/note_list/:cas_id GETReturns the notes list for a process/pmse_Inbox/reactivateFlows PUTDeprecated endpoint./pmse_Inbox/reassignFlows PUTCall methods to reassign processes/pmse_Inbox/reassignFlows/:record GETRetrieve information to reassign
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-42
|
GETRetrieve information to reassign processes/pmse_Inbox/:record/file/:field GETReturns the process status image file/pmse_Inbox/save_notes POSTCreates a new note for a process/pmse_Inbox/settings GETRetrieve settings for the PA engine/pmse_Inbox/settings PUTUpdate settings for the SugarBPMTM engine/pmse_Inbox/unattendedCases GETRetrieves the processes to show on Unattended Process view/pmse_Inbox/userListByTeam/:id GETDeprecated endpoint./pmse_Project/ActivityDefinition/:record GETRetrieves the definition data for an activity/pmse_Project/ActivityDefinition/:record PUTUpdates the definition data for an activity/pmse_Project/CrmData/:data/:filter GETRetrieves information about Fields, Modules, Users, Roles,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-43
|
GETRetrieves information about Fields, Modules, Users, Roles, etc./pmse_Project/CrmData/:record/:filter PUTUpdates information about Fields, Modules, Users, Roles, etc./pmse_Project/EventDefinition/:record GETRetrieves the definition data for an event/pmse_Project/EventDefinition/:record PUTUpdates the definition data for an event/pmse_Project/GatewayDefinition/:record GETRetrieves the definition data for a gateway/pmse_Project/GatewayDefinition/:record PUTUpdates the definition data for a gateway/pmse_Project GETLists filtered records./pmse_Project/file/project_import POSTImports a Process Definition from a .bpm file/pmse_Project/project/:record GETRetrieves the schema data to be used by the Process Definition
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-44
|
GETRetrieves the schema data to be used by the Process Definition designer/pmse_Project/project/:record PUTUpdates the schema data from the Process Definition designer/pmse_Project/:record/dproject GETExports a .bpm file with a Process Definition/pmse_Project/:record/verify GETVerifies whether the Process Definition has any pending processes/pmse_Project/validateCrmData/:data/:filter GETValidates information about Fields, Modules, Users, Roles, etc./recent GETReturns all of the current users recently viewed records./rssfeed GETConsumes an RSS feed as a proxy and returns the feed up to a certain number of entries./search GETList records in a module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times./theme
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-45
|
Additionally the set of returned fields can be restricted to speed up processing and reduce download times./theme GETFetches the customizable variables of a theme./theme POSTUpdates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/index.html
|
90580c61aff5-46
|
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/index.html
|
da5d03bfe106-0
|
/pmse_Project/GatewayDefinition/:record GET
Overview
Retrieves the definition data for a gateway
Summary
This endpoint will retrieve the JSON encoded definition data for the Process
Definition gateway identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the gat_uid field in the pmse_bpmn_gateway record
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
data
Array
The definition data for the gateway
Response
{
"success":true,
"data":
[
{
"flo_uid":"985528634573cabc8901d04029355451",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectGatewayDefinitionrecord_GET/index.html
|
da5d03bfe106-1
|
"flo_condition":"[{\u0022expType\u0022:\u0022BUSINESS_RULES\u0022,\u0022expLabel\u0022:\u0022Action # 1 is equal to \\\u0022TRUE\\\u0022\u0022,\u0022expValue\u0022:\u0022TRUE\u0022,\u0022expOperator\u0022:\u0022equals\u0022,\u0022expField\u0022:\u0022b6d2500c-bf29-2ad7-67a2-569d5debc7d9\u0022}]"
}
]
}
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_ProjectGatewayDefinitionrecord_GET/index.html
|
718176b349a5-0
|
/Mail/recipients/find GET
Overview
Finds recipients that match the search term.
Request Arguments
Name
Type
Description
Required
q
string
The search string
False
module_list
string
One of the following strings: users, accounts, contacts, leads, prospects, all
Will determine which modules are searched using the given search string.
False
order_by
string
columns to sort by (one or more of $sortableColumns) with direction
Example: name:asc,id:desc (will sort by last_name ASC and then id DESC)
False
offset
int
Offset of first record to return
False
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html
|
718176b349a5-1
|
Offset of first record to return
False
max_num
int
Maximum records to return
False
Request
?q=foo&module_list=all&order_by=name:asc,id:desc&offset=1&max_num=4
Response Arguments
Name
Type
Description
next_offset
int
Returns the next offset to be used if paging ahead for more records
records
Array
Array of records found based on the search string and module_list. Each record contains the ID, module,
name, email address and it's ID, opt out flag of the email address, and _acl of the recipient found.
Response
{
"next_offset": 3,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailrecipientsfind_GET/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.