id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
55f40296fa1a-1
|
},
"_module": "Currencies"
},
{
"id": "a3cba348-756c-935c-66ad-55d772c7960f",
"name": "Euro",
"symbol": "â¬",
"iso4217": "EUR",
"conversion_rate": 0.9,
"status": "Active",
"date_modified": "2015-08-21T11:47:51-07:00",
"created_by": "1",
"_acl": {
"fields": {}
},
"_module": "Currencies"
}
]
}
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/Currencies_GET/index.html
|
0981ec500aa8-0
|
/pmse_Project/project/:record PUT
Overview
Updates the schema data from the Process Definition designer
Summary
This endpoint will update the Process Definition identified by the
record input parameter with data provided in the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The Process Definition record ID
True
Request Payload
{
"data":
{
"activities":{},
"gateways":
{
"407410601573ce3125db315056173234":
{
"action":"REMOVE",
"gat_uid":"407410601573ce3125db315056173234"
}
},
"events":{},
"artifacts":{},
"flows":{},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Projectprojectrecord_PUT/index.html
|
0981ec500aa8-1
|
"artifacts":{},
"flows":{},
"prj_uid":"2119da13-f748-4741-3858-573caddda034"
},
"id":"2119da13-f748-4741-3858-573caddda034",
"operation":"update",
"wrapper":"Project"
}
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_Projectprojectrecord_PUT/index.html
|
dc75462b036d-0
|
/<module>/:record/link/:link_name/leancount 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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-1
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-2
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-3
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-4
|
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-5
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-6
|
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-7
|
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,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-8
|
"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/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-9
|
"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"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-10
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-11
|
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-12
|
"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":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-13
|
"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",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-14
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-15
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-16
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-17
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-18
|
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameleancount_GET/index.html
|
dc75462b036d-19
|
"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/modulerecordlinklink_nameleancount_GET/index.html
|
7cbba1a75b08-0
|
/<module>/sync_key/:sync_key_field_value DELETE
Overview
Deletes the record with the given sync_key.
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 deleted.
Response
Status 200
{ "id": "a0328573-a252-a27c-3530-4e4297d4c9e1"}
Change Log
Version
Change
v11_10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_DELETE/index.html
|
7cbba1a75b08-1
|
Change Log
Version
Change
v11_10
Added /<module>/sync_key/:sync_key_field_value DELETE endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulesync_keysync_key_field_value_DELETE/index.html
|
991e3b31334e-0
|
/Users/:record DELETE
Delete a User and return its ID
Summary:
This endpoint is used to delete a User. Returns the ID of the deleted 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/Usersrecord_DELETE/index.html
|
d3b28072b7e8-0
|
/pmse_Emails_Templates/file/emailtemplates_import POST
Overview
Imports a Process Email Templates definition from a .pet file
Summary
This endpoint will import a Process Email Templates definition from the
uploaded .pet file containing JSON encoded data.
Request Arguments
Name
Type
Description
Required
N/A
Request
Note: A JSON encoded .pet file attachment should be included with
the request as part of the form-data.
Response Arguments
Name
Type
Description
emailtemplates_import
Object
Result of the import operation
Response
{
"emailtemplates_import":
{
"success":true,
"id":"aa5f7fd9-73a9-8338-fd1a-573635ce5c51"
}
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesfileemailtemplates_import_POST/index.html
|
d3b28072b7e8-1
|
}
}
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_Templatesfileemailtemplates_import_POST/index.html
|
76e6f844be8f-0
|
/Administration/settings/auth GET
Overview
[ADMIN] Fetch auth settings.
Summary
This endpoint will return auth settings. This endpoint is only available to administrators when IDM migration is turned on.
Response if enabled only local auth provider
{
"enabledProviders": [
"local"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
}
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-1
|
"attempt": 0
}
}
}
Response if enabled local and ldap auth providers
{
"enabledProviders": [
"local",
"ldap"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
},
"ldap": {
"user": {
"mapping": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-2
|
"ldap": {
"user": {
"mapping": {
"givenName": "first_name",
"sn": "last_name",
"mail": "email1",
"telephoneNumber": "phone_work",
"facsimileTelephoneNumber": "phone_fax",
"mobile": "phone_mobile",
"street": "address_street",
"l": "address_city",
"st": "address_state",
"postalCode": "address_postalcode",
"c": "address_country"
}
},
"adapter_config": {
"host": "127.0.0.1",
"port": "389",
"options": {
"network_timeout": 60,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-3
|
"options": {
"network_timeout": 60,
"timelimit": 60
},
"encryption": "none"
},
"adapter_connection_protocol_version": 3,
"baseDn": "dc=openldap,dc=com",
"uidKey": "uid",
"filter": "({uid_key}={username})",
"dnString": null,
"entryAttribute": null,
"autoCreateUser": "1",
"searchDn": "cn=admin,ou=admins,dc=openldap,dc=com",
"searchPassword": "admin&password"
}
}
Response if enabled local and saml auth providers
{
"enabledProviders": [
"local",
"saml"
],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-4
|
"local",
"saml"
],
"local": {
"password_requirements": {
"minimum_length": 6,
"maximum_length": 0,
"require_upper": true,
"require_lower": true,
"require_number": true,
"require_special": false,
"password_regex": "",
"regex_description": ""
},
"password_expiration": {
"time": 0,
"attempt": 0
}
},
"saml": {
"strict": true,
"debug": false,
"sp": {
"entityId": "logoutFlowWithRedirectBinding",
"assertionConsumerService": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-5
|
"assertionConsumerService": {
"url": "http://localhost/index.php?module=Users&action=Authenticate",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
},
"singleLogoutService": {
"url": "http://localhost/index.php?module=Users&action=Logout",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
},
"NameIDFormat": "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress",
"x509cert": "",
"privateKey": "",
"provisionUser": true,
"sugarCustom": []
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-6
|
"provisionUser": true,
"sugarCustom": []
},
"idp": {
"entityId": "http://localhost:8080/simplesaml/saml2/idp/metadata.php",
"singleSignOnService": {
"url": "http://localhost:8080/simplesaml/saml2/idp/SSOService.php",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
},
"singleLogoutService": {
"url": "http://localhost:8080/simplesaml/saml2/idp/SingleLogoutService.php",
"binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationsettingsauth_GET/index.html
|
76e6f844be8f-7
|
},
"x509cert": "-----BEGIN CERTIFICATE-----\n --x509cert-- \n-----END CERTIFICATE-----"
},
"security": {
"authnRequestsSigned": false,
"logoutRequestSigned": false,
"logoutResponseSigned": false,
"signatureAlgorithm": "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256",
"validateRequestId": false
}
}
}
Change Log
Version
Change
v11_2
Added /Administration/settings/auth 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/Administrationsettingsauth_GET/index.html
|
3aaec6497378-0
|
/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value PUT
Overview
Sets a sync key value for a record. Note that the PATCH method is recommended over the PUT method.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
record_id
String
The ID of the record whose sync key will be set
True
sync_key_field_name
String
The name of the field that contains sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
sync_key_field_value
String
A unique ID for the record identifying it in an external system
True
Request
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PUT/index.html
|
3aaec6497378-1
|
String
A unique ID for the record identifying it in an external system
True
Request
/integrate/<module>/:record_id/:sync_key_field_name/:sync_key_field_value
Response
{"success": true}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:record_id/:sync_key_field_name/: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/Integratemodulerecord_idsync_key_field_namesync_key_field_value_PUT/index.html
|
f6cc78db8645-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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html
|
f6cc78db8645-1
|
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html
|
f6cc78db8645-2
|
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"
},
{
"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"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html
|
f6cc78db8645-3
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html
|
f6cc78db8645-4
|
},
{
"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"
},
{
"id":"shipping_address_street",
"_module":"Quotes",
"name":"Shipping Address",
"rhs_module":"Quotes"
},
{
"id":"shipping_usdollar",
"_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
|
f6cc78db8645-5
|
"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"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Emails_Templatesvariablesfind_GET/index.html
|
f6cc78db8645-6
|
"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
|
570c725ddc28-0
|
/<module>/globalsearch GET
Overview
Global search
Summary
This endpoint exposes the global search capability using solely the Elasticsearch backend as an alternative to the
/search endpoint. This endpoint can be used with a long list of request arguments. Instead of using GET request
arguments, all described arguments can be used inside a JSON encoded request body using a the GET request. If your
client has no support for GET requests with a body, the POST method can be used as an alternative.
Request Arguments
Name
Type
Description
Required
q
String
The search expression. Multiple terms can be specified at once. All enabled fields will be searched in. The
results are ordered by relevance which is based on a multitude of settings based on token counts, hit
ratio, (weighted) boost values and type of field. Currently no operators are supported in the search
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html
|
570c725ddc28-1
|
expression itself. By refining the search expression more relevant results will be returned as top results.
If no search expression is given results are returned based on last modified date.
False
module_list
String
Comma delimited list of modules to search. If omitted, all search enabled modules will be queried. Note that
when consuming the endpoint /:module/globalsearch that this parameter is ignored.
Example: Accounts,Contacts
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
highlights
Boolean
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html
|
570c725ddc28-2
|
False
highlights
Boolean
Wether or not to return highlighted results. Default is true.
False
sort
Array
Define the sort order of the results. By default the results are returned by relevance which is the
preferred approach. Using this argument any search enabled field can be used to sort on. Keep in mind the
not sorting by relevance may have a negative performance impact.
Example: {"date_modified":"desc","name":"asc"}
False
Request
{
}
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleglobalsearch_GET/index.html
|
570c725ddc28-3
|
records.
records
Array
An array of results containing matched records.
Response
{
}
Change Log
Version
Change
v10
Added /globalsearch GET/POST endpoint.
v10
Added /:module/globalsearch GET/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/moduleglobalsearch_GET/index.html
|
53f48692b602-0
|
/ForecastManagerWorksheets/assignQuota POST
Assign Quotas to All Reporting Users for a given timeperiod
Summary:
This endpoint is used to assign out the quota to the reporting users with out having to commit a forecast.
Parameters:
Param
Description
Optional
user_id
The Manager's user id for who is assigning out the quota
false
timeperiod_id
Which timeperiod are we assigning quota for
false
Input Example:
{ "user_id" : "seed_sarah_id",
"timeperiod_id" : "36f7085a-5889-ea75-84c8-50f42bd1a5ba"
}
Output Example:
{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/ForecastManagerWorksheetsassignQuota_POST/index.html
|
0c3a9c4c358a-0
|
/OutboundEmailConfiguration/list GET
Overview
Lists the current user's outbound email configurations for sending email.
Summary
Used by the Emails module for selecting an outbound email configuration for sending an email.
Response
[
{
"id": "ecbf2a6c-261e-5fca-fbb6-512d093554b8",
"name": "George Lee ",
"type": "user",
"default": false
},
{
"id": "af5f8dae-7169-b497-1d77-512d0937ed81",
"name": "ACME, Inc. ",
"type": "system",
"default": true
}
]
Change Log
Version
Change
v11
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/OutboundEmailConfigurationlist_GET/index.html
|
0c3a9c4c358a-1
|
}
]
Change Log
Version
Change
v11
Last version in which /OutboundEmailConfiguration/list GET is available. Use
/Emails/enum/outbound_email_id GET instead.
v10
Added the /OutboundEmailConfiguration/list 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/OutboundEmailConfigurationlist_GET/index.html
|
c3931eab740a-0
|
/Leads/register POST
Overview
Creates new Leads.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"first_name":"John",
"last_name":"Smith"
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the newly created record.
Response
{
"id":"ecba9f86-4a4a-def6-359c-505a5b33f014",
"name":"John Smith",
"date_entered":"2012-09-19T23:54:54+0000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsregister_POST/index.html
|
c3931eab740a-1
|
"date_modified":"2012-09-19T23:54:54+0000",
"modified_user_id":"1",
"created_by":"1",
"deleted":0,
"team_id":"1",
"team_set_id":"1",
"first_name":"John",
"last_name":"Smith",
"full_name":"John Smith",
"do_not_call":false,
"converted":false,
"lead_source":"Support Portal User Registration",
"status":"New",
"preferred_language":"en_us",
"email":[
],
"my_favorite":false
}
Change Log
Version
Change
v10
Added /Leads/register POST endpoint.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsregister_POST/index.html
|
c3931eab740a-2
|
v10
Added /Leads/register 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/Leadsregister_POST/index.html
|
582ce205b639-0
|
/Administration/settings/idmMode DELETE
Overview
[ADMIN] Turn IDM-mode off.
Summary
This endpoint switches IDM mode off. This is only available to administrators when IDM migration is turned on and intended for internal use for IDM integration.
Response when IDM mode has been disabled
[]
Change Log
Version
Change
v11_2
Added /Administration/settings/idmMode 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/AdministrationsettingsidmMode_DELETE/index.html
|
23382743f176-0
|
/Emails/:record/link/:link_name/add_record_list/:remote_id POST
Overview
Creates relationships to a pre-existing email from a record list.
Summary
Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records
as a sender (link: from) or recipients(links: to, cc, bcc). All other operations
described in Relate Record API are supported.
Change Log
Version
Change
v10
Added /Emails/:record/link/:link_name/add_record_list/:remote_id POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlinklink_nameadd_record_listremote_id_POST/index.html
|
7fae53476ffd-0
|
/Forecasts/init GET
ForecastsApi - init
Summary:
This endpoint is used to return initialization data for the Forecasts module.
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
Output Example:
{
"initData":
{
"selectedUser":
{
"preferences":
{
"timezone":"GMT",
"datepref":"m\/d\/Y",
"timepref":"h:ia",
"currency_id":"-99",
"currency_name":"US Dollars",
"currency_symbol":"$",
"currency_iso":"USD",
"currency_rate":1,
"decimal_precision":"2",
"decimal_separator":".",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html
|
7fae53476ffd-1
|
"decimal_separator":".",
"number_grouping_separator":",",
"language":"en_us",
"default_teams":
[{
"id":1,
"display_name":"Global",
"name":"Global",
"name_2":"",
"primary":true
}]
},
"module_list":
[
"Home",
"Accounts",
"Contacts",
"Opportunities",
"Leads","Calendar",
"Reports",
"Quotes",
"Documents",
"Emails",
"Campaigns",
"Calls",
"Meetings",
"Tasks",
"Notes",
"Forecasts",
"Cases",
"Prospects",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html
|
7fae53476ffd-2
|
"Forecasts",
"Cases",
"Prospects",
"ProspectLists",
"Bugs",
"Employees"
],
"type":"user",
"id":"seed_jim_id",
"full_name":"Jim Brennan",
"user_name":"jim",
"picture":"46d1fbfb-c258-ce81-fa3a-50f809925709",
"acl":
{
"Forecasts":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
"ForecastWorksheets":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html
|
7fae53476ffd-3
|
"ForecastManagerWorksheets":{"fields":[],"admin":"no","_hash":"095777549714234c8192a7a7963c38b8"},
},
"my_teams":
[
{"id":"8833dfef-c1f4-e8b3-ca3b-50f8093616be","name":"Chris Olliver"},
{"id":"East","name":"East"},{"id":1,"name":"Global"},
{"id":"4ae6baba-f356-7374-7eb4-50f809745551","name":"Jim Brennan"},
{"id":"707a642a-710b-37f1-88f6-50f8098205c0","name":"Max Jensen"},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html
|
7fae53476ffd-4
|
{"id":"63308ab9-f663-bae8-90a5-50f80951c0fe","name":"Sally Bronsen"},
{"id":"5776c705-8e6e-4bfc-44e5-50f809d12c0e","name":"Sarah Smith"},
{"id":"West","name":"West"},
{"id":"7cf7ee0b-f88e-b566-d4d3-50f809dcb717","name":"Will Westin"}
],
"showOpps":false,
"first_name":"Jim",
"last_name":"Brennan",
"admin":"yes"
},
"forecasts_setup":1
},
"defaultSelections":
{
"timeperiod_id":
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsinit_GET/index.html
|
7fae53476ffd-5
|
{
"timeperiod_id":
{
"id":"a2ab9ad3-2101-36f8-7ba3-50f809b3b62c",
"label":"Q1 (01\/01\/2013 - 03\/31\/2013)"
},
"ranges":["include"],
"group_by":"forecast",
"dataset":"likely"
}
}
}
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/Forecastsinit_GET/index.html
|
ec0bbc04a891-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.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmovefirsttarget_PUT/index.html
|
ec0bbc04a891-1
|
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
|
24c1e8708045-0
|
/me GET
Overview
Returns the current user object.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Response User
{
"current_user":{
"type":"user",
"id":"1",
"full_name":"Administrator",
"timepref":"h:ia",
"timezone":"America/Los_Angles",
"user_name":"admin"
}
}
Response Portal User
{
"current_user":{
"type":"support_portal",
"id":"1234-567",
"user_id":"abcd-123",
"full_name":"Bill Williamson",
"timepref":"h:ia",
"timezone":"America/Denver",
"user_name":"SupportPortalApi"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/me_GET/index.html
|
24c1e8708045-1
|
"user_name":"SupportPortalApi"
}
}
Change Log
Version
Change
v10
Added /me 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/me_GET/index.html
|
1a94b851a415-0
|
/<module>/:record/file/:field GET
Overview
Retrieves an attached file for a specific field on a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.
Response
Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding...
Change Log
Version
Change
v10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_GET/index.html
|
1a94b851a415-1
|
Change Log
Version
Change
v10
Added /<module>/:record/file/:field GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfilefield_GET/index.html
|
0767ec9d14d1-0
|
/Reports/:record/chart GET
Overview
An API to get chart data for a saved report.
Summary
This endpoint will return chart data for a saved report.
Request Arguments
None.
Request Example
GET /rest/v10/Reports/:id/chart
Response Arguments
Name
Type
Description
reportData
Array
Report def for the chart.
chartData
Array
The chart data for a report.
Response
{
"reportData":
{
"label":"Accounts by Industry",
"id":"a06b4212-3509-11e7-ab6e-f45c898a3ce7",
...
},
"chartData":
{
"properties":[...],
"values":[...],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Reportsrecordchart_GET/index.html
|
0767ec9d14d1-1
|
{
"properties":[...],
"values":[...],
...
}
}
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/Reportsrecordchart_GET/index.html
|
74d00cdaca55-0
|
/Administration/idm/migration/disable POST
Overview
[ADMIN] Disable Idm migrations
Summary
This endpoint disables 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/disable 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/Administrationidmmigrationdisable_POST/index.html
|
e9731a7b352b-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
|
867db9ee5b6f-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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-1
|
"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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-2
|
"id": "1",
"_acl": {
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
},
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-3
|
"_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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-4
|
"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",
"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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-5
|
"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": [],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-6
|
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"currency_id": "-99",
"base_rate": "1.000000",
"currency_name": "",
"currencies": {
"name": "",
"id": "-99",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
},
"symbol": ""
},
"currency_symbol": "",
"my_favorite": false,
"_acl": {
"fields": {}
},
"_module": "Opportunities"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-7
|
},
"_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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-8
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-9
|
"pwd_last_changed": {
"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"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-10
|
}
},
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-11
|
"quote_type": "Quotes",
"date_quote_expected_closed": "2012-04-30",
"original_po_date": "",
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-12
|
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-13
|
"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": "",
"id": "0029279c-2d3d-11e8-a121-024289eecda3",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-14
|
}
},
"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": {
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-15
|
"_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
|
867db9ee5b6f-16
|
"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,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-17
|
"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": [],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-18
|
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"team_name": [{
"id": "1",
"name": "Global",
"name_2": "",
"primary": true,
"selected": false
}],
"currency_id": "-99",
"base_rate": "1.000000",
"currency_name": "",
"currencies": {
"name": "",
"id": "-99",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
},
"symbol": ""
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Quotesrecordopportunity_POST/index.html
|
867db9ee5b6f-19
|
},
"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
|
32c43dcd4ef5-0
|
/<module>/duplicateCheck POST
Overview
Runs a duplicate check against specified data.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"name":"Airline"
}
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the potential duplicate records.
Response
{
"next_offset":-1,
"records":[
{
"id":"c4c26496-5dbc-67dd-bf5c-512d0923889e",
"name":"Airline Maintenance Co",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html
|
32c43dcd4ef5-1
|
"name":"Airline Maintenance Co",
"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_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html
|
32c43dcd4ef5-2
|
"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":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Other",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"123 Anywhere Street",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html
|
32c43dcd4ef5-3
|
"billing_address_street":"123 Anywhere Street",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"Sunnyvale",
"billing_address_state":"CA",
"billing_address_postalcode":"48566",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(648) 452-3486",
"phone_alternate":"",
"website":"www.kidqa.it",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"123 Anywhere Street",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html
|
32c43dcd4ef5-4
|
"shipping_address_street":"123 Anywhere Street",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"Sunnyvale",
"shipping_address_state":"CA",
"shipping_address_postalcode":"48566",
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleduplicateCheck_POST/index.html
|
32c43dcd4ef5-5
|
"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":{
}
},
"duplicate_check_rank":0
}
]
}
Change Log
Version
Change
v10
Added /<module>/duplicateCheck 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/moduleduplicateCheck_POST/index.html
|
6c527aaf235e-0
|
/ExpressionEngine/:record/related POST
Retrieve a Forecasting Information In SugarChart Format
Summary:
This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Â
user_id
Show for a specific user
Â
display_manager
Pipeline or Committed are valid values.
Â
dataset
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified
Optional
group_by
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales Stage
Optional
ranges
Pipeline or Committed are valid values.
Optional
Input Example:
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ExpressionEnginerecordrelated_POST/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.