id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
24283563a4f0-1
|
"rel":"my_opportunities"
},
"children":[
],
"data":"Opportunities (Jim Brennan)",
"metadata":{
"first_name":"Jim",
"full_name":"Jim Brennan",
"id":"seed_jim_id",
"last_name":"Brennan",
"level":"1",
"reports_to_id":"",
"user_name":"jim"
},
"state":""
},
{
"attr":{
"id":"jstree_node_will",
"rel":"manager"
},
"children":[
],
"data":"Will Westin",
"metadata":{
"first_name":"Will",
"full_name":"Will Westin",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html
|
24283563a4f0-2
|
"first_name":"Will",
"full_name":"Will Westin",
"id":"seed_will_id",
"last_name":"Westin",
"level":"2",
"reports_to_id":"seed_jim_id",
"user_name":"will"
},
"state":"closed"
},
{
"attr":{
"id":"jstree_node_sarah",
"rel":"manager"
},
"children":[
],
"data":"Sarah Smith",
"metadata":{
"first_name":"Sarah",
"full_name":"Sarah Smith",
"id":"seed_sarah_id",
"last_name":"Smith",
"level":"2",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecastsreporteesuser_id_GET/index.html
|
24283563a4f0-3
|
"last_name":"Smith",
"level":"2",
"reports_to_id":"seed_jim_id",
"user_name":"sarah"
},
"state":"closed"
}
],
"data":"Jim Brennan",
"metadata":{
"first_name":"Jim",
"full_name":"Jim Brennan",
"id":"seed_jim_id",
"last_name":"Brennan",
"level":"1",
"reports_to_id":"",
"user_name":"jim"
},
"state":"open"
}
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/Forecastsreporteesuser_id_GET/index.html
|
d69191ffd861-0
|
/<module>/filter POST
Overview
Lists filtered records.
Summary
This endpoint will return a set of records filtered by an expression. The filter can be applied to multiple fields
and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its id.
If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long. Related fields can be searched by specifying the field name as:
"link_name.remote_field", so if you wished to search the Accounts module by a related member account you would
use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-1
|
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
filter_id
String
Identifier for a preexisting filter. If filter is also set, the two
filters are joined with an AND.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned.
Example: name,account_type,description
False
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-2
|
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
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
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-3
|
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example
you would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-4
|
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-5
|
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-6
|
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-7
|
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-8
|
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-9
|
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-10
|
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-11
|
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"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/modulefilter_POST/index.html
|
d69191ffd861-12
|
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-13
|
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-14
|
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-15
|
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-16
|
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"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",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-17
|
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-18
|
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
d69191ffd861-19
|
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/filter POST endpoint.
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulefilter_POST/index.html
|
0b5de9519b14-0
|
/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value POST
Overview
Creates a relationship based on lhs_sync_key_field_name and rhs_sync_key_field_name. If both the LHS and RHS records can be found with the respective fields, then relate the RHS record to the LHS record.
Request Arguments
Name
Type
Description
Required
module
String
The module the record belongs to
True
lhs_sync_key_field_name
String
The name of the LHS field that contains lhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html
|
0b5de9519b14-1
|
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_name
String
The name of the RHS field that contains rhs_sync_key_field_value (the default field is named sync_key but can be renamed via code customization)
True
rhs_sync_key_field_value
String
A unique ID for the RHS record identifying it in an external system
True
Request
/integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value
Response Arguments
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html
|
0b5de9519b14-2
|
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",
"error_message": "Could not find record with :xhs_sync_key_field_name::xhs_sync_key_field_value in module: <module>"
}
Change Log
Version
Change
v11_10
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html
|
0b5de9519b14-3
|
}
Change Log
Version
Change
v11_10
Added /integrate/<module>/:lhs_sync_key_field_name/:lhs_sync_key_field_value/link/:link_name/:rhs_sync_key_field_name/:rhs_sync_key_field_value 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/Integratemodulelhs_sync_key_field_namelhs_sync_key_field_valuelinklink_namerhs_sync_key_field_namerhs_sync_key_field_value_POST/index.html
|
a1714f2b1dd0-0
|
/ForecastManagerWorksheets/export GET
Overview
Returns a record set in CSV format along with HTTP headers to indicate content type.
Request Arguments
Name
Type
Description
Required
uid
Array
A list of bean ids.
False
filter
Array
The filter expression. More information on filter expressions can be found in /<module>/filter.
False
sample
Array
Indicates whether to download sample data.
False
Request
Exporting Records by Specific IDs
{
"uid":"d43243c6-9b8e-2973-aee2-512d09bc34b4"
}
Exporting Records by a List of IDs
{
"uid":[
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsexport_GET/index.html
|
a1714f2b1dd0-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/ForecastManagerWorksheetsexport_GET/index.html
|
a1714f2b1dd0-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/ForecastManagerWorksheetsexport_GET/index.html
|
a1714f2b1dd0-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/ForecastManagerWorksheetsexport_GET/index.html
|
a1714f2b1dd0-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/ForecastManagerWorksheetsexport_GET/index.html
|
7563078aaf6a-0
|
/pmse_Inbox GET
Overview
Returns a list of Processes by user using filters
Summary
This endpoint gets a list of processes by user using filters
Request Arguments
Name
Type
Description
Required
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.
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
filter
string
The filter expression
false
filter_id
string
Identifier for a preexisting filter. If filter is also set, the two filters are joined with an AND
false
max_num
integer
A maximum number of records to return. Default is 20.
false
offset
integer
The number of records to skip over before records are returned. Default is 0.
false
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html
|
7563078aaf6a-1
|
The number of records to skip over before records are returned. Default is 0.
false
fields
string
Comma delimited list of fields to return
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
records
<field>:<value>
Process records
next_offset
integer
Next offset for results
Response
{
"next_offset":-1,
"records":
[
{
"id":"839ccd22-2925-11e6-83f3-6c4008960436",
"date_modified":"2016-06-02T17:52:55-07:00",
"created_by":"1",
"cas_finish_date":"",
"assigned_user_id":"1",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html
|
7563078aaf6a-2
|
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"assigned_user_link":
{
"full_name":"Administrator",
"id":"1",
"_acl":
{
"fields":
{
"pwd_last_changed":
{
"write":"no",
"create":"no"
},
"last_login":
{
"write":"no",
"create":"no"
}
},
"delete":"no",
"_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"_acl":
{
"fields":{}
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html
|
7563078aaf6a-3
|
"_acl":
{
"fields":{}
},
"_module":"pmse_Project\/pmse_BpmFlow",
"_locked_fields":[],
"cas_id":"4",
"act_assignment_method":"static",
"cas_title":"PQR1",
"pro_title":"PD1",
"date_entered":"2016-06-02T17:52:55-07:00",
"name":"PQR1",
"cas_create_date":"2016-06-02T17:52:55-07:00",
"flow_id":"839ccd22-2925-11e6-83f3-6c4008960436",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html
|
7563078aaf6a-4
|
"id2":"8380e512-2925-11e6-9600-6c4008960436",
"task_name":"Activity # 1",
"cas_assignment_method":"static",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"82d5c470-2925-11e6-a269-6c4008960436",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
"in_time":true,
"cas_user_id":"1",
"prj_created_by":"1",
"cas_user_id_full_name":"Administrator",
"prj_user_id_full_name":"Administrator"
},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inbox_GET/index.html
|
7563078aaf6a-5
|
"prj_user_id_full_name":"Administrator"
},
]
}
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_Inbox_GET/index.html
|
3c9a4fa96885-0
|
/pmse_Project/CrmData/:data/:filter GET
Overview
Retrieves information about Fields, Modules, Users, Roles, etc.
Summary
This endpoint will retrieve various data related to the Process
Definition.
Request Arguments
Name
Type
Description
Required
data
String
The type of data to be retrieved
True
filter
String
Filtering criteria to be applied to data retrieved
False
Request
Note: Additional input parameters can be provided in the form
of a URL query string.
/rest/v11/pmse_Project/CrmData/related/Accounts?cardinality=one
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
search
String
The value of the filter input parameter
result
Array
The data requested
Response
{
"search":"Accounts",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html
|
3c9a4fa96885-1
|
result
Array
The data requested
Response
{
"search":"Accounts",
"success":true,
"result":
[
{
"value":"Accounts",
"text":"\u003CAccounts\u003E",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"Accounts"
},
{
"value":"member_of",
"text":"Accounts (Member of: member_of)",
"module":"Accounts",
"module_label":"Accounts",
"module_name":"Accounts",
"relationship":"member_accounts"
},
{
"value":"campaign_accounts",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html
|
3c9a4fa96885-2
|
},
{
"value":"campaign_accounts",
"text":"Campaigns (Campaigns: campaign_accounts)",
"module":"Campaigns",
"module_label":"Campaigns",
"module_name":"Campaigns",
"relationship":"campaign_accounts"
},
{
"value":"assigned_user_link",
"text":"Users (Assigned to User: assigned_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_assigned_user"
},
{
"value":"created_by_link",
"text":"Users (Created by User: created_by_link)",
"module":"Users",
"module_label":"Users",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html
|
3c9a4fa96885-3
|
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_created_by"
},
{
"value":"modified_user_link",
"text":"Users (Modified by User: modified_user_link)",
"module":"Users",
"module_label":"Users",
"module_name":"Users",
"relationship":"accounts_modified_user"
}
]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectCrmDatadatafilter_GET/index.html
|
dbca705128e0-0
|
/Administration/packages POST
Overview
[ADMIN] PackageManager upload package.
Summary
Uploads a module loadable package via a multi-part form request. The only parameter is 'upgrade_zip' which must contain a valid module loadable zip file.
Sample Request
POST /rest/v11_1/Administration/packages HTTP/1.1
Host: null
Content-Type: multipart/form-data
Accept: application/json
OAuth-Token: 3bbd6227-cfd0-45c7-8a6e-3c737e3c73ff
Content-Type: multipart/form-data; boundary=---------------------------9051914041544843365972754266
Content-Length: 554
-----------------------------9051914041544843365972754266
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_POST/index.html
|
dbca705128e0-1
|
-----------------------------9051914041544843365972754266
Content-Disposition: form-data; name="upgrade_zip"; filename="module.zip"
Content-Type: application/zip
{content-data}
-----------------------------9051914041544843365972754266--
Response
Returns status 200 OK and file hashes for install and delete package if request is successful.
{
"file_install": "5d4b4614421586fd2111714abf622392",
"unFile": "5d4b4614421586fd2111714abf622392"
}
Otherwise returns status 4xx with errors.
{
"error": "upload_package_error",
"error_message": "Issue with the manifest",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationpackages_POST/index.html
|
dbca705128e0-2
|
"error_message": "Issue with the manifest",
"error_description": "The uploaded file is not compatible with this version of Sugar: 11.3.0"
}
Change Log
Version
Change
v11.8
Added /Administration/packages 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/Administrationpackages_POST/index.html
|
88784e4aeea8-0
|
/ForecastManagerWorksheets/filter POST
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return selective ManagerWorksheets with the optional filter parameter.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastManagerWorksheets/filter
{
"filter":[
{"assigned_user_id" : "seed_jim_id"},
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html
|
88784e4aeea8-1
|
{"assigned_user_id" : "seed_jim_id"},
{"timeperiod_id":"e546185a-5889-ea75-84c8-511178d1a5ba"}
],
}
Output Example:
{ "next_offset": -1,
"records": [
{
"id": "ad3908c7-83a3-f360-c223-51117844c208",
"name": "Grow-Fast Inc - 1000 units",
"date_entered": "2013-02-05T21:22:00+00:00",
"date_modified": "2013-02-05T21:22:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html
|
88784e4aeea8-2
|
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"deleted": "0",
"assigned_user_id": "seed_jim_id",
"assigned_user_name": "Jim Brennan",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"account_name": "",
"account_id": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html
|
88784e4aeea8-3
|
"account_name": "",
"account_id": "",
"likely_case": "75000",
"best_case": "75000",
"worst_case": "75000",
"base_rate": "1",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-10",
"date_closed_timestamp": "1360531443",
"sales_stage": "Perception Analysis",
"probability": "70",
"commit_stage": "include",
"draft": "1",
"my_favorite": false,
"_acl": {
"fields": {}
}
}]
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html
|
88784e4aeea8-4
|
"fields": {}
}
}]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetsfilter_POST/index.html
|
79b319e63527-0
|
/VCardDownload GET
Overview
Downloads a vCard.
Request Arguments
Name
Type
Description
Required
id
String
The id of the vcard.
True
module
String
The name of the module to get the vcard from.
True
Request
http://{site_url}/rest/v10/VCardDownload?id=2c9e5c09-6824-0d14-f5cb-5130321ac3cf&module=Contacts
Note: GET endpoint parameters are passed in the form of a query string.
Response Arguments
Name
Type
Description
<vcard information>
String;
Record in vcard format.
Response
BEGIN:VCARD
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/VCardDownload_GET/index.html
|
79b319e63527-1
|
Record in vcard format.
Response
BEGIN:VCARD
N;CHARSET=utf-8:Leone;Rosemarie;;
FN;CHARSET=utf-8: Rosemarie Leone
BDAY:
TEL;WORK;FAX:
TEL;HOME;CHARSET=utf-8:(692) 586-8287
TEL;CELL;CHARSET=utf-8:(117) 577-0969
TEL;WORK;CHARSET=utf-8:(844) 325-7679
EMAIL;INTERNET;CHARSET=utf-8:[email protected]
ADR;WORK;CHARSET=utf-8:;;777 West Filmore Ln;San Mateo;CA;74984;USA
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/VCardDownload_GET/index.html
|
79b319e63527-2
|
ORG;CHARSET=utf-8:Q.R.&E. Corp;
TITLE;CHARSET=utf-8:Director Sales
END:VCARD
Change Log
Version
Change
v10
Added /VCardDownload 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/VCardDownload_GET/index.html
|
f1ca92c03b1a-0
|
/<module>/:record/link/:link_name/add_record_list/:remote_id POST
Overview
Creates relationships to pre-existing record from a record list.
URL Arguments
Name
Type
Description
Required
<record ID>
<string>
Target record ID.
True.
<report ID>
<string>
Report ID for Saved Report.
True.
<relationship link>
<string>
Link between targeted and related records.
True.
Request
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f1ca92c03b1a-1
|
related_records
Array
Record IDs that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f1ca92c03b1a-2
|
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
"id": "West",
"name": "West",
"name_2": "",
"primary": true
}
],
"opportunity_type": "",
"account_name": "Slender Broadband Inc",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f1ca92c03b1a-3
|
"account_name": "Slender Broadband Inc",
"account_id": "181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id": "",
"campaign_name": "",
"lead_source": "Campaign",
"amount": "25000",
"base_rate": "1",
"amount_usdollar": "25000",
"currency_id": "-99",
"currency_name": "",
"currency_symbol": "",
"date_closed": "2013-02-27",
"date_closed_timestamp": "1361992480",
"next_step": "",
"sales_stage": "Needs Analysis",
"sales_status": "New",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f1ca92c03b1a-4
|
"sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
},
"related_records": [
success: [
"e689173e-c953-1e14-c215-512d0927e7a2",
"da6a3741-2a81-ba7f-f249-512d0932e94e",
"181461c6-dc81-1115-1fe0-512d092e8f15"
],
error: []
]
}
Change Log
Version
Change
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f1ca92c03b1a-5
|
],
error: []
]
}
Change Log
Version
Change
v10 (7.2.0)
Added /<module>/: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/modulerecordlinklink_nameadd_record_listremote_id_POST/index.html
|
f12da2f55623-0
|
/Administration/elasticsearch/refresh/trigger POST
Overview
[ADMIN] Elasticsearch trigger explicit index refresh on all indices
Summary
Trigger an explicit index refresh for all indices managed by SugarCRM. This endpoint is only
available to administrators.
Response
{
"aabbcc_contactsleads": 200,
"aabbcc_accountsonly": 200,
"aabbcc_shared": 200
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/refresh/trigger 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/Administrationelasticsearchrefreshtrigger_POST/index.html
|
7ec089867439-0
|
/pmse_Project/GatewayDefinition/:record PUT
Overview
Updates the definition data for a gateway
Summary
This endpoint will update the Process Definition gateway identified by the
record input parameter with the data provided by the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The value for the gat_uid field in the pmse_bpmn_gateway record
True
Request Payload
{
"data":
[
{
"flo_uid":"985528634573cabc8901d04029355451",
"flo_condition":""
}
]
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
"success":true
}
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectGatewayDefinitionrecord_PUT/index.html
|
7ec089867439-1
|
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_ProjectGatewayDefinitionrecord_PUT/index.html
|
ace7f8a57b3e-0
|
/pmse_Inbox/note_list/:cas_id GET
Overview
Returns the notes list for a process
Summary
This endpoint gets the notes for a process
Request Arguments
Name
Type
Description
Required
cas_id
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
rowList
object
Note records
totalRows
integer
Total notes
currentOffset
integer
Current offset
currentDate
integer
Current date
Response
{
"rowList":
[
{
"pmse_bpm_notes__date_entered":"2016-06-02 16:52:21",
"id":"602d4cb0-28e2-11e6-88c9-6c4008960436",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxnote_listcas_id_GET/index.html
|
ace7f8a57b3e-1
|
"date_entered":"2016-06-02T09:52:21-07:00",
"date_modified":"2016-06-02T09:52:21-07:00",
"cas_id":"2",
"cas_index":"1",
"not_user_id":"1",
"not_user_recipient_id":"",
"not_type":"GENERAL",
"not_date":null,
"not_status":"ACTIVE",
"not_availability":"",
"not_content":"Test Note1",
"not_recipients":"",
"first_name":null,
"last_name":"Administrator",
"picture":"0b2dc2f0-2377-11e6-9d2a-6c4008960436"
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxnote_listcas_id_GET/index.html
|
ace7f8a57b3e-2
|
}
],
"totalRows":1,
"currentOffset":0,
"currentDate":"2016-06-02 16:52:39"
}
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_Inboxnote_listcas_id_GET/index.html
|
0228617fc7a5-0
|
/Mail/address/validate POST
Overview
Validate one or more email addresses.
Request Arguments
Type
Description
Required
Array
Array of one or more email addresses to validate.
True
Request
[
"[email protected]",
"[email protected]",
"invalid-email.com"
]
Response Arguments
Type
Description
Object
Returns an object with each email address as a key and a boolean
indicating whether the email address is valid as the value.
Response
{
"[email protected]": true,
"[email protected]": true,
"invalid-email.com": false
}
Change Log
Version
Change
v11
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Mailaddressvalidate_POST/index.html
|
0228617fc7a5-1
|
}
Change Log
Version
Change
v11
Last version in which /Mail/address/validate POST is available.
v10
Added /Mail/address/validate 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/Mailaddressvalidate_POST/index.html
|
ad8630aa6486-0
|
/pmse_Inbox/userListByTeam/:id GET
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_InboxuserListByTeamid_GET/index.html
|
acd4148229cd-0
|
/Administration/elasticsearch/mapping GET
Overview
[ADMIN] Elasticsearch mapping
Summary
This endpoint returns the mapping for every available index. This endpoint is only available to administrators.
Response
{
"autobr2583_shared":{
"KBDocuments":{
"dynamic":"false",
"_all":{
"enabled":false
},
"properties":{
"kbdocument_name":{
"type":"string",
"index":"not_analyzed",
"fields":{
"gs_string_default":{
"type":"string",
"analyzer":"gs_analyzer_default"
},
"gs_string_ngram":{
"type":"string",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchmapping_GET/index.html
|
acd4148229cd-1
|
"gs_string_ngram":{
"type":"string",
"index_analyzer":"gs_analyzer_ngram",
"search_analyzer":"gs_analyzer_default"
}
}
}
}
},
"RevenueLineItems":{
"dynamic":"false",
"_all":{
"enabled":false
},
"properties":{
"date_modified":{
"type":"string",
"index":"not_analyzed",
"fields":{
"gs_datetime":{
"type":"date",
"index":"no",
"format":"YYYY-MM-dd HH:mm:ss"
}
}
},
"description":{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationelasticsearchmapping_GET/index.html
|
acd4148229cd-2
|
}
}
},
"description":{
"type":"string",
"index":"not_analyzed",
"fields":{
"gs_string_default":{
"type":"string",
"analyzer":"gs_analyzer_default"
},
"gs_string_ngram":{
"type":"string",
"index_analyzer":"gs_analyzer_ngram",
"search_analyzer":"gs_analyzer_default"
}
}
}
}
}
}
}
Change Log
Version
Change
v10
Added /Administration/elasticsearch/mapping 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/Administrationelasticsearchmapping_GET/index.html
|
6914296673be-0
|
/pmse_Inbox/ReassignForm/:data/:flowId GET
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_InboxReassignFormdataflowId_GET/index.html
|
da775d4459e6-0
|
/<module>/:record DELETE
Overview
Delete a record of a specified type.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
id
String
Returns the ID of the deleted record.
Response
{
"id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9"
}
Change Log
Version
Change
v10
Added /<module>/:record 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/modulerecord_DELETE/index.html
|
37f6ee16a720-0
|
/ForecastManagerWorksheets/:timeperiod_id/:user_id GET
Returns a collection of ForecastManagerWorksheet models
Summary:
This end point is used to return the ManagerWorksheets for a user at a given timeperiod. If no timeperiod is provide it
will use the default timeperiod, likewise if no user is provided, it will default to the logged in user.
Url Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period, defaults to the current time period if one is not passed
Optional
user_id
Show for a specific user, defaults to current user if not defined
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found
403 - Not Authorized
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-1
|
403 - Not Authorized
If you are not an administrator, but you are trying to view another managers forecast manager worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastManagerWorksheets/:timeperiod_id/:user_id
Output Example:
{
"next_offset":-1,
"records":[
{
"id":"401594f5-5b46-fb66-1627-55771fe8723e",
"name":"Sally Bronsen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"1932.444445",
"best_case":"29848.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-2
|
"best_case":"29848.000000",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556",
"worst_case":"27540.888889",
"worst_case_adjusted":"34426.111111",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_sally_id",
"opp_count":10,
"pipeline_opp_count":3,
"pipeline_amount":"2415.555556",
"closed_amount":"26278.888889",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-3
|
"closed_amount":"26278.888889",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-4
|
"_module":"ForecastManagerWorksheets"
},
{
"id":"28226f12-a3c9-bd84-041e-55771f064c4e",
"name":"Max Jensen",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"3141.333332",
"best_case":"15848.222223",
"best_case_adjusted":"13206.851853",
"likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"worst_case_adjusted":"11673.518519",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-5
|
"worst_case_adjusted":"11673.518519",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":false,
"user_id":"seed_max_id",
"opp_count":12,
"pipeline_opp_count":3,
"pipeline_amount":"2617.777777",
"closed_amount":"12310.444445",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-6
|
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
},
{
"id":"1aca66af-f069-bba4-28a1-55771fe27506",
"name":"",
"date_modified":"2015-06-09T13:13:26-04:00",
"created_by":"1",
"quota":"10142.333333",
"best_case":"37625.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-7
|
"best_case":"37625.000000",
"best_case_adjusted":"37625.000000",
"likely_case":"34241.333333",
"likely_case_adjusted":"34241.333333",
"worst_case":"30857.666667",
"worst_case_adjusted":"30857.666667",
"timeperiod_id":"adb78e81-3fbd-b4e0-287f-55771fd04a06",
"draft":true,
"is_manager":true,
"user_id":"seed_sarah_id",
"opp_count":13,
"pipeline_opp_count":6,
"pipeline_amount":"10142.333333",
"closed_amount":"24099.000000",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
37f6ee16a720-8
|
"closed_amount":"24099.000000",
"manager_saved":true,
"show_history_log":0,
"following":false,
"assigned_user_id":"seed_sarah_id",
"assigned_user_name":"Sarah Smith",
"team_name":[
{
"id":"1",
"name":"Global",
"name_2":"",
"primary":true
}
],
"currency_id":"-99",
"base_rate":"1.000000",
"_acl":{
"fields":{
}
},
"_module":"ForecastManagerWorksheets"
}
]
}
Last modified: 2023-02-03 21:04:03
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html
|
2830c82a7767-0
|
/Users 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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
2830c82a7767-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/Users_GET/index.html
|
b9a7a0445262-0
|
/Genericsearch POST
Overview
Generic search.
Summary
This endpoint searches the content of the given modules using the provider specified by the "generic_search" configuration variable. If the variable is absent, the default provider is "Elastic".
Request Arguments
Name
Type
Description
Required
q
String
The search expression.
True
module_list
String
Comma-delimited list of modules to search. If omitted, all search enabled modules will be queried. Example: KBDocuments,Bugs
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
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.
total
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_POST/index.html
|
b9a7a0445262-1
|
total
Integer
The number of records found.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"total": 1,
"records": [
{
"name": "Connecting to the Internet",
"description": "To connect your device to the Internet, use any application that accesses the Internet. You can connect using either Wi-Fi or Bluetooth.",
"url": "portal/index.html#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for portal)
"url": "#KBContents/60142236-bad3-11e9-9d32-3c15c2d57622" (for base)
}
]
}
Change Log
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Genericsearch_POST/index.html
|
b9a7a0445262-2
|
}
]
}
Change Log
Version
Change
v11_9
Added /Genericsearch 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/Genericsearch_POST/index.html
|
e3ca6369c2f9-0
|
/Teams/:record/link POST
Overview
Creates relationships to a pre-existing record.
Request Arguments
Name
Type
Description
Required
<relationship link>
<string>
Link between targeted and related records.
True
<record ID>
<string>
The name value list of related records. Each item of the list may be either string equal to related item ID,
or map containing record ID ("id" key is required in this case)
and addition relationship properties.
True
Request
{
link_name: "accounts"
ids: [
"da6a3741-2a81-ba7f-f249-512d0932e94e",
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-1
|
{
"id": "e689173e-c953-1e14-c215-512d0927e7a2",
"role": "owner"
}
]
}
Response Arguments
Name
Type
Description
record
Array
The record linked to related records.
related_records
Array
Records that were associated.
Response
"record": {
"id": "da6a3741-2a81-ba7f-f249-512d0932e94e",
"name": "Slender Broadband Inc - 1000 units",
"date_entered": "2013-02-26T19:12:00+00:00",
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
e3ca6369c2f9-2
|
"date_modified": "2013-02-26T19:12:00+00:00",
"modified_user_id": "1",
"modified_by_name": "Administrator",
"created_by": "1",
"created_by_name": "Administrator",
"description": "",
"img": "",
"last_activity_date": "2013-02-28T18:21:00+00:00",
"deleted": false,
"assigned_user_id": "seed_max_id",
"assigned_user_name": "Max Jensen",
"team_name": [
{
"id": "East",
"name": "East",
"name_2": "",
"primary": false
},
{
|
https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Teamsrecordlink_POST/index.html
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.