id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
7aad56c0ca91-2
|
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-3
|
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-4
|
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-5
|
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-6
|
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-7
|
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-8
|
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-9
|
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-10
|
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
7aad56c0ca91-11
|
"description":"",
"opportunities": [
{
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Employees_GET/index.html
|
8530fe035ea4-0
|
/KBContents/filter GET
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-1
|
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
Note that JSON-encoded filters can be specified as query parameters
in one of two ways for GET requests:
By specifying individual filter arguments as distinct parameters.
Example: filter[0][id]=1.
By specifying the whole filter as a single JSON-encoded string.
Note that this syntax is currently not supported on certain modules.
Example: filter=[{"id":"1"}].
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-2
|
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
Example: name,account_type,description,{"name":"opportunities","fields":["id","name","sales_status"],"order_by":"date_closed:desc"}
For more details on additional field parameters, see
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-3
|
For more details on additional field parameters, see
Relate API and
Collection API.
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
q
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-4
|
False
q
String
A search expression, will search on this module. Cannot be used at the same time as a filter expression or id.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
nulls_last
Boolean
Boolean to return records with null values in order_by fields last in the result set.
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-5
|
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you
would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-6
|
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-7
|
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-8
|
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-9
|
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_module: "Opportunities",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-10
|
{
_module: "Opportunities",
"id": "b0701501-1fab-8ae7-3942-540da93f5017",
"name": "360 Vacations - 228 Units",
"date_modified": "2014-09-08T16:05:00+03:00",
"sales_status": "New"
},
],
"_acl": {
"fields": {
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_modified":"2013-02-26T19:12:00+00:00",
"description":"",
"opportunities": [
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
8530fe035ea4-11
|
"description":"",
"opportunities": [
{
_module: "Opportunities"
date_modified: "2014-09-08T16:05:00+03:00"
id: "9ce7c088-8ee4-7cd3-18f1-540da944d4c0"
name: "360 Vacations - 312 Units"
sales_status: "New"
},
],
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/KBContentsfilter_GET/index.html
|
b3c95948d522-0
|
/<module>/:record/moveafter/:target PUT
Overview
Move existing node after target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to move node after
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>/moveafter/:target PUT endpoint.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordmoveaftertarget_PUT/index.html
|
b3c95948d522-1
|
Added /<module>/moveafter/: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/modulerecordmoveaftertarget_PUT/index.html
|
70d1f9b18ce0-0
|
/pmse_Inbox/reactivateFlows PUT
Overview
Deprecated endpoint.
Summary
This endpoint is deprecated and will be removed in a future release.
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_InboxreactivateFlows_PUT/index.html
|
bef92e40aa3a-0
|
/login/content GET
Overview
Returns information to facilitate receiving marketing content from SugarCRM.
Request Arguments
Name
Type
Description
Required
selected_language
String
Code for the desired marketing content language. (Eg. "en_us", "fr_FR").
Providing a certain language code does not guarantee that content returned will be in the provided language.
If an invalid language is specified, will assume "en_us".
False. Defaults to "en_us"
Response Arguments
Name
Type
Description
content_url
String
URL suitable for embedding in an iFrame that links to new marketing material from SugarCRM.
Will always be provided, but may be an empty string if there is no suitable content available.
Response
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/logincontent_GET/index.html
|
bef92e40aa3a-1
|
Response
{
"content_url": "https://marketing.sugarcrm.com/exciting-new-content"
}
Change Log
Version
Change
v11_2
Added /login/content 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/logincontent_GET/index.html
|
9de78b9c7704-0
|
/<module>/globalsearch POST
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_POST/index.html
|
9de78b9c7704-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_POST/index.html
|
9de78b9c7704-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_POST/index.html
|
9de78b9c7704-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_POST/index.html
|
7d8190a42660-0
|
/recent GET
Overview
Returns all of the current users recently viewed records.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to return recently viewed records.
Example: Accounts,Contacts
True
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: id,name
False
date
String
The date expression. Filter recently viewed records from this date.
False
limit
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-1
|
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
Request
http://{site_url}/rest/v10/recent?module_list=Accounts%2CContacts
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
next_offset
String
The next offset to start fetching additional records.
records
Array
An array of recently viewed records.
Response
{
"next_offset":-1,
"records":[
{
"my_favorite":false,
"following":false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-2
|
{
"my_favorite":false,
"following":false,
"id":"e4213959-35cd-119b-5cd6-5342e8be16f6",
"name":"Leila Purifoy",
"date_entered":"2014-04-07T13:58:50-04:00",
"date_modified":"2014-04-07T13:58:50-04:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"assigned_user_id":"seed_will_id",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-3
|
"assigned_user_id":"seed_will_id",
"assigned_user_name":"Will Westin",
"team_count":"",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":true
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":false
}
],
"email":[
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":true,
"primary_address":false,
"reply_to_address":false
},
{
"email_address":"[email protected]",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-4
|
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":true,
"reply_to_address":true
}
],
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"email_addresses_non_primary":"",
"salutation":"",
"first_name":"Leila",
"last_name":"Purifoy",
"full_name":"Leila Purifoy",
"title":"President",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-5
|
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(841) 469-8223",
"phone_mobile":"(286) 010-9553",
"phone_work":"(369) 075-2809",
"phone_other":"",
"phone_fax":"",
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Santa Monica",
"primary_address_state":"NY",
"primary_address_postalcode":"52255",
"primary_address_country":"USA",
"alt_address_street":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-6
|
"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":"Trade Show",
"account_name":"Sea Region Inc",
"account_id":"b1cd3a55-7e84-e53b-954e-5342e85b63f1",
"dnb_principal_id":"",
"opportunity_role_fields":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-7
|
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"birthdate":"",
"portal_name":"LeilaPurifoy5",
"portal_active":true,
"portal_password":true,
"portal_password1":null,
"portal_app":"",
"preferred_language":"",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"accept_status_calls":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-8
|
"accept_status_calls":"",
"accept_status_meetings":"",
"sync_contact":false,
"mkto_sync":false,
"mkto_id":null,
"mkto_lead_score":null,
"_acl":{
"fields":{
}
},
"_module":"Contacts",
"_last_viewed_date":"2014-04-07T14:43:46-04:00"
},
{
"my_favorite":false,
"following":false,
"id":"e8f7eb6d-2647-7e57-df30-5342e83c622d",
"name":"Draft Diversified Energy Inc",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-9
|
"name":"Draft Diversified Energy Inc",
"date_entered":"2014-04-07T13:58:50-04:00",
"date_modified":"2014-04-07T13:58:50-04:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_count":"",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-10
|
"name_2":"",
"primary":true
}
],
"email":[
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":true,
"reply_to_address":false
},
{
"email_address":"[email protected]",
"invalid_email":false,
"opt_out":false,
"primary_address":false,
"reply_to_address":false
}
],
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-11
|
"invalid_email":false,
"email_opt_out":false,
"email_addresses_non_primary":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Education",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"111 Silicon Valley Road",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"Los Angeles",
"billing_address_state":"CA",
"billing_address_postalcode":"26022",
"billing_address_country":"USA",
"rating":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-12
|
"billing_address_country":"USA",
"rating":"",
"phone_office":"(790) 406-0049",
"phone_alternate":"",
"website":"www.phonesugar.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"111 Silicon Valley Road",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"Los Angeles",
"shipping_address_state":"CA",
"shipping_address_postalcode":"26022",
"shipping_address_country":"USA",
"parent_id":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/recent_GET/index.html
|
7d8190a42660-13
|
"shipping_address_country":"USA",
"parent_id":"",
"sic_code":"",
"duns_num":"",
"parent_name":"",
"campaign_id":"",
"campaign_name":"",
"_acl":{
"fields":{
}
},
"_module":"Accounts",
"_last_viewed_date":"2014-04-07T14:43:36-04:00"
}
]
}
Change Log
Version
API
Change
7.2.0
v10
Added /recent 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/recent_GET/index.html
|
944d5ec2d662-0
|
/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value POST
Overview
Creates 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 record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_value
String
A unique ID for the LHS record identifying it in an external system
True
link_name
String
A name for the link
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_POST/index.html
|
944d5ec2d662-1
|
A unique ID for the RHS record identifying it in an external system
True
Request
/<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value
Response Arguments
Name
Type
Description
record
String
The ID of the record.
related_record
String
The ID of the related record.
Response
Status 200
{
"record": "a0328573-a252-a27c-3530-4e4297d4c9e1",
"related_record": "a0328573-bc54-a554-3530-4e4297d4c9e1"
}
Status 422
{
"error": "invalid_parameter",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_POST/index.html
|
944d5ec2d662-2
|
}
Status 422
{
"error": "invalid_parameter",
"error_message": "Could not find record with :xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
Added /<module>/:lhs_sync_key_field_value/link_by_sync_keys/:link_name/:rhs_sync_key_field_value 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/modulelhs_sync_key_field_valuelink_by_sync_keyslink_namerhs_sync_key_field_value_POST/index.html
|
5315d06d46c9-0
|
/<module>/export/:record_list_id GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html
|
5315d06d46c9-1
|
}
Exporting Records by a List of IDs
{
"uid":[
"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"b3e87a3f-cd8f-7b86-467a-512d09e8d240"
]
}
Exporting Records Using a Filter
{
"filter":[
{
"name":"airline"
}
]
}
Exporting a Sample Result Set
{
"sample":true
}
Response Arguments
Name
Type
Description
<csv export>
String
Returns the selected records in CSV format with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 04:05:55 GMT
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html
|
5315d06d46c9-2
|
Date: Fri, 01 Mar 2013 04:05:55 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17
X-Powered-By: PHP/5.3.17
Expires: Mon, 26 Jul 1997 05:00:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: cache
Content-Disposition: attachment; filename=Accounts.csv
Content-transfer-encoding: binary
Last-Modified: Fri, 01 Mar 2013 04:05:55 GMT
Cache-Control: post-check=0, pre-check=0
Content-Length: 1080
Connection: close
Content-Type: application/octet-stream; charset=UTF-8
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html
|
5315d06d46c9-3
|
Content-Type: application/octet-stream; charset=UTF-8
"Name","ID","Website","Email Address","Office Phone","Alternate Phone","Fax","Billing Street","Billing City","Billing State","Billing Postal Code","Billing Country","Shipping Street","Shipping City","Shipping State","Shipping Postal Code","Shipping Country","Description","Type","Industry","Annual Revenue","Employees","SIC Code","Ticker Symbol","Parent Account ID","Ownership","Campaign ID","Rating","Assigned User Name","Assigned To","Team ID","Teams","Team Set ID","Date Created","Date Modified","Modified By","Created By","Deleted","Image","last_activity_date","Linkedin Company ID","Facebook Account","Twitter Account","Google Plus ID"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html
|
5315d06d46c9-4
|
"Arts & Crafts Inc","d43243c6-9b8e-2973-aee2-512d09bc34b4","","","(052) 034-1853","","","777 West Filmore Ln","Santa Monica","CA","35354","USA","777 West Filmore Ln","Santa Monica","CA","35354","USA","","Customer","Transportation","","","","","","","","","sally","seed_sally_id","West","West","West","02/26/2013 07:12 pm","02/26/2013 07:12 pm","1","1","0","","02/26/2013 07:12 pm","","","",""
Change Log
Version
Change
v10
Added /<module>/export GET endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleexportrecord_list_id_GET/index.html
|
52b34be4f104-0
|
/<module>/prepend/:target POST
Overview
Append new node to target node as first child.
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 prepend new node
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This enpdoint returns a newly created record GUID
{
"my_favorite":false,
"following":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html
|
52b34be4f104-1
|
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f",
"name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html
|
52b34be4f104-2
|
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/prepend/:target POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleprependtarget_POST/index.html
|
934819c636dd-0
|
/Opportunities/config POST
Overview
Opportunity Config Save
Summary
This saves the config changes to the Opportunity Module, when the opps_view_by attribute changes, it will perform the nessicary migrations for the Metadata and the actual Data.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Opportunitiesconfig_POST/index.html
|
934819c636dd-1
|
}
Change Log
Version
Change
v10
Added /Opportunities/config 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/Opportunitiesconfig_POST/index.html
|
282355e2081d-0
|
/me/following GET
Overview
Returns all of the current users followed records
Request Arguments
limit and offset are available query parameters.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/following 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/mefollowing_GET/index.html
|
b71704f125ba-0
|
/KBContents/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/KBContentsduplicateCheck_POST/index.html
|
b71704f125ba-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/KBContentsduplicateCheck_POST/index.html
|
b71704f125ba-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/KBContentsduplicateCheck_POST/index.html
|
b71704f125ba-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/KBContentsduplicateCheck_POST/index.html
|
b71704f125ba-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/KBContentsduplicateCheck_POST/index.html
|
b71704f125ba-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/KBContentsduplicateCheck_POST/index.html
|
57eec7ecfa7e-0
|
/<module>/:record/link/:link_name POST
Overview
Creates a related record.
Request Arguments
Name
Type
Description
Required
<record field>
<record field type>
The name value list of fields to populate.
True
Request
{
"first_name":"Bill",
"last_name":"Edwards"
}
Response Arguments
Name
Type
Description
record
Array
The record associated to the newly created record.
related_record
Array
The record that was created and associated.
Response
{
"record":{
"id":"da6a3741-2a81-ba7f-f249-512d0932e94e",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-1
|
"name":"Slender Broadband Inc - 1000 units",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-2
|
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-3
|
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e1c495cb-af17-1b37-dd66-512f934fe155",
"name":"Bill Edwards",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-4
|
"name":"Bill Edwards",
"date_entered":"2013-02-28T17:25:00+00:00",
"date_modified":"2013-02-28T17:25:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"",
"assigned_user_name":"",
"team_name":[
{
"id":1,
"name":"Global",
"name_2":"",
"primary":true
}
],
"salutation":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-5
|
"primary":true
}
],
"salutation":"",
"first_name":"Bill",
"last_name":"Edwards",
"full_name":"Bill Edwards",
"title":"",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"",
"email":[
],
"phone_mobile":"",
"phone_work":"",
"phone_other":"",
"phone_fax":"",
"email1":"",
"email2":"",
"invalid_email":"",
"email_opt_out":"",
"primary_address_street":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-6
|
"email_opt_out":"",
"primary_address_street":"",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"",
"primary_address_state":"",
"primary_address_postalcode":"",
"primary_address_country":"",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_name_POST/index.html
|
57eec7ecfa7e-7
|
"picture":"",
"email_and_name1":"",
"lead_source":"",
"account_id":"",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"",
"portal_active":false,
"portal_password":"",
"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_name_POST/index.html
|
57eec7ecfa7e-8
|
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name 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/modulerecordlinklink_name_POST/index.html
|
7d33ca1089a5-0
|
/Contacts/:record/freebusy GET
Get a contact's FreeBusy schedule
Summary:
This endpoint returns a list of time slots for which the specified person is busy.
Request
GET /Contacts/:id/freebusy
Response
{
"id": "foo"
"module": "Users",
"freebusy": [
{
"start": "2014-08-24T08:45:00-04:00",
"end": "2014-08-24T09:15:00-04:00"
},
{
"start": "2014-08-30T05:45:00-04:00",
"end": "2014-08-30T06:15:00-04:00"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Contactsrecordfreebusy_GET/index.html
|
7d33ca1089a5-1
|
},
{
"start": "2014-09-12T15:45:00-04:00",
"end": "2014-09-12T16:15:00-04:00"
}
]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Contactsrecordfreebusy_GET/index.html
|
5370968126b5-0
|
/<module>/config POST
Overview
Retrieves the config settings for a given module.
Summary
This endpoint is normally used to manage the forecasting module.
Request Arguments
Name
Type
Description
Required
<config field>
<config field type>
The list of config fields to update.
False
Request
{
"MyConfigOption":"MyConfigValue"
}
Response Arguments
Name
Type
Description
<config field>
<config field type>
The list of config fields will be returned.
Response
{
"MyConfigOption":"MyConfigValue"
}
Change Log
Version
Change
v10
Added /<module>/config POST endpoint.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleconfig_POST/index.html
|
5370968126b5-1
|
v10
Added /<module>/config 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/moduleconfig_POST/index.html
|
805a07389299-0
|
/Forecasts/:timeperiod_id/:user_id/chart/:display_manager GET
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/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-1
|
ranges
Pipeline or Committed are valid values.
Optional
Input Example:
{
'user_id':'seed_max_id,
'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
'display_manager':'false',
'group_by': 'forecast',
'dataset': 'likely',
'ranges': 'include',
}
Output Example:
{ "color" : [ "#8c2b2b",
"#468c2b",
"#2b5d8c",
"#cd5200",
"#e6bf00",
"#7f3acd",
"#00a9b8",
"#572323",
"#004d00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-2
|
"#572323",
"#004d00",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-3
|
"goal_marker_color" : [ "#000000",
"#7D12B2"
],
"goal_marker_label" : [ "Quota",
"Likely Case"
],
"goal_marker_type" : [ "group",
"pareto"
],
"label_name" : "Include in Forecast",
"labels" : "value",
"legend" : "on",
"print" : "on",
"subtitle" : "",
"thousands" : "",
"title" : null,
"type" : "bar chart",
"value_name" : "Likely Case"
} ],
"values" : [ { "goalmarkervalue" : [ "111000.00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-4
|
"36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 25500,
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-5
|
],
"gvalue" : 25500,
"gvaluelabel" : "$25,500.00",
"label" : "February 2013",
"links" : [ "" ],
"valuelabels" : [ "$25,500.00" ],
"values" : [ 25500 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 0,
"gvaluelabel" : "$0.00",
"label" : "March 2013",
"links" : [ "" ],
"valuelabels" : [ "$0.00" ],
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
805a07389299-6
|
"valuelabels" : [ "$0.00" ],
"values" : [ 0 ]
}
]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html
|
a3b446818df6-0
|
/Dashboards GET
Overview
List current user's filtered Home dashboards.
Summary
This endpoint will return a set of Home dashboards filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its
id. If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long.
Notice
The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to
GET /<module>. If you continue to use v10 of the API,
your REST calls should behave as before. But, it is advisable to upgrade to v11. Slight differences exist in
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-1
|
the GET method of v10 vs v11.Migrating to v11:
Recommended Replacement:
GET /Dashboards
The Home module is no longer the default dashboard_module. To get the Home module
dashboard, include the following filter parameter.v11:
GET /Dashboards?filter[0][dashboard_module]=Home
name, id. etc. are no longer specified as default fields. To retain the default fields, usev11:
GET /Dashboards?filter[0][dashboard_module]=Home&fields=id,name,view_name
Request Arguments
Name
Type
Description
Required
filter
String
See Filter API.
False
filter_id
String
Identifier for a preexisting filter. See
the Filter API for details.
False
max_num
Integer
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-2
|
the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
For more details on additional field parameters, see
Relate API and
Collection API.
False
order_by
String
See Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response Arguments
Name
Type
Description
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-3
|
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"records": [
{
"id": "c630c772-faca-2051-6a42-56fab2e73e42",
"name": "New Home Dashboard",
"date_modified": "2016-03-29T09:49:06-07:00",
"view_name": "",
"_acl": {
"fields": {}
},
"view": "",
"_module": "Dashboards"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-4
|
"_module": "Dashboards"
},
{
"id": "15677f2c-f00d-c59a-6fbe-56fab1f33732",
"name": "Home Dashboard2",
"date_modified": "2016-03-29T09:47:25-07:00",
"view_name": "",
"_acl": {
"fields": {}
},
"view": "",
"_module": "Dashboards"
},
{
"id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
"name": "Accounts Dashboard",
"date_modified": "2016-03-29T09:46:00-07:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-5
|
"view_name": "records",
"_acl": {
"fields": {}
},
"view": "records",
"_module": "Dashboards"
},
{
"id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
"name": "Activity Stream Dashboard",
"date_modified": "2016-03-29T09:57:58-07:00",
"view_name": "activities",
"_acl": {
"fields": {}
},
"view": "activities",
"_module": "Dashboards"
}
]
}
Change Log
Version
Change
v11
Behavior has changed. Please see GET /Dashboards
for the designated replacement.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html
|
a3b446818df6-6
|
for the designated replacement.
v10
Added /Dashboards 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/Dashboards_GET/index.html
|
550eff29799f-0
|
/me/password PUT
Overview
Create a new record of a specified type.
Summary
This endpoint allows for changes to the user's password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User
Request Arguments
Name
Type
Description
Required
old_password
String
The current password.
True
new_password
String
The new password.
True
Request
{
"old_password":"myoldpass",
"new_password":"mynewpass"
}
Response Arguments
Name
Type
Description
valid
Boolean
Returns the success of the password verification.
expiration
Date
When the password will expire.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_PUT/index.html
|
550eff29799f-1
|
expiration
Date
When the password will expire.
Response
{
"valid":true,
"expiration":null
}
Change Log
Version
Change
v10
Added /me/password PUT endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/mepassword_PUT/index.html
|
2eaebe78dc3a-0
|
/<module>/MassUpdate PUT
Overview
An API to mass update records.
Query String Parameters
Name
Type
Description
Required
massupdate_params
Array
Mass update parameters.
True
massupdate_params.uid
Array
A list of ids.
True
massupdate_params.[field name]
[field type]
The field to be modified.
False
massupdate_params.team_name
Array
Team array.
False
massupdate_params.team_name_type
String
Whether to replace or add teams. Possible values are 'add' and 'replace'.
False
Request
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html
|
2eaebe78dc3a-1
|
False
Request
Mass Updating Records by ID in a Module
{
"massupdate_params":{
"uid":[
"f22d1955-97d8-387d-9866-512d09cc1520",
"ef1b40aa-5815-4f8d-e909-512d09617ac8"
],
"department":"Marketing"
}
}
Mass Updating Records with Teams
{
"massupdate_params":{
"uid":[
"f22d1955-97d8-387d-9866-512d09cc1520",
"ef1b40aa-5815-4f8d-e909-512d09617ac8"
],
"team_name":[
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html
|
2eaebe78dc3a-2
|
],
"team_name":[
{
"id":"35eab226-c20d-48f4-4670-512d095c8c6f",
"primary":true
},
{
"id":"8f640aba-f356-7374-7eb4-512d09745551",
"primary":false
}
],
"team_name_type":"replace"
}
}
Mass Add Leads, Contacts or Prospects to a Target List
{
"massupdate_params": {
"uid": [ /* Leads, Contacts, or Prospects to Add */
"f3d90a49-14b4-a81c-6cac-526e6c71d33e",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html
|
2eaebe78dc3a-3
|
"f22cde0d-9a20-89d3-ca14-526e6c3c4d08",
"f15f10bd-1445-5e20-9b5c-526e6ceb71d0"
],
"prospect_lists": [
/* Prospect List(s) to Add them To */
"bc5bc249-9c9c-52ad-52b9-526e71f0e18d"
]
}
}
Response Arguments
Name
Type
Description
Status
String
The status of the mass update. Possible value is 'done'.
Output Done Example
{
"status":"done"
}
Change Log
Version
Change
v10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleMassUpdate_PUT/index.html
|
2eaebe78dc3a-4
|
}
Change Log
Version
Change
v10
Added /<module>/MassUpdate 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/moduleMassUpdate_PUT/index.html
|
24283563a4f0-0
|
/Forecasts/reportees/:user_id GET
ForecastsApi Reportees
Summary:
This endpoint is used to return the json Data for an array of users and their state for the forecasts users tree filter
Query Parameters:
Param
Description
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
level
Level of child notes, defaults to 1, -1 for all levels
Optional
Input Example:
{
'user_id':'seed_max_id'
}
Output Example:
{
"attr":{
"id":"jstree_node_jim",
"rel":"root"
},
"children":[
{
"attr":{
"id":"jstree_node_myopps_jim",
"rel":"my_opportunities"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.