id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
d083660e9dd0-11 | "fields": {
}
}
},
{
"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/KBContentsrecordlink_POST/index.html |
d083660e9dd0-12 | "description": "",
"img": "",
"last_activity_date": "2013-02-28T18:36: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/KBContentsrecordlink_POST/index.html |
d083660e9dd0-13 | "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/KBContentsrecordlink_POST/index.html |
d083660e9dd0-14 | "sales_status": "New",
"probability": "90",
"best_case": "25000",
"worst_case": "25000",
"commit_stage": "include",
"my_favorite": false,
"_acl": {
"fields": {
}
}
}
]
}
Change Log
Version
Change
v10 (7.6.0)
Added support for additional relationship values.
v10 (7.1.5)
Added /<module>/:record/link 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/KBContentsrecordlink_POST/index.html |
bc869014630c-0 | /ForecastWorksheets/filter POST
Returns a collection of ForecastWorksheet models
Summary:
This end point is used to return the Worksheets 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.
Also this end points use the visibility requirements set forth by the application, that if the records being requested
belong to you, you will get the draft version, If the worksheet is not yours, you will only see the committed version.
Query Parameters:
Param
Description
Optional
filter
What you want to filter on
Optional
type
Which type to return, currently the ones that are supported are, opportunity and product
Optional
Possible Errors
Error
Description
412 - Invalid Parameter
When the passed in timeperiod and/or user can not be found | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
bc869014630c-1 | When the passed in timeperiod and/or user can not be found
403 - Not Authorized
If you are not a manager, but you are tyring to view another sales rep forecast worksheet, you will receive a 403 Not Authorized Error
Url Example:
/rest/v10/ForecastWorksheets/:timeperiod_id/:user_id
{
"filter":[
{"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
bc869014630c-2 | "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",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
bc869014630c-3 | {
"id": "East",
"name": "East",
"name_2": "",
"primary": true
}
],
"parent_id": "50b90565-e748-ed77-d9d7-511178f5acae",
"parent_type": "Opportunities",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastWorksheetsfilter_POST/index.html |
bc869014630c-4 | "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": {}
}
}]
}
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/ForecastWorksheetsfilter_POST/index.html |
42d4cc2df927-0 | /<module>/filter/count 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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
42d4cc2df927-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/modulefiltercount_POST/index.html |
de4e0e0c281a-0 | /pmse_Inbox/casesList GET
Overview
Returns a list with the processes for Process Management
Summary
This endpoint gets a list of Processes.
Request Arguments
Name
Type
Description
Required
module_list
string
Identifier used to determine which status to filter against
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.
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html |
de4e0e0c281a-1 | 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
false
deleted
boolean
Boolean to show deleted records in the result set.
false
Response Arguments
Name
Type
Description
next_offset
Integer
Next offset
records
<field>/<value>
List of process attributes
Response
{
{
"next_offset":-1,
"records":
[
{
"id":"3922976c-284f-11e6-9f40-6c4008960436",
"name":"ABC2",
"date_entered":"2016-06-01T16:18:59-07:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html |
de4e0e0c281a-2 | "date_modified":"2016-06-01T16:18:59-07:00",
"modified_user_id":"1",
"created_by":"1",
"deleted":"0",
"cas_id":"2",
"cas_parent":"0",
"cas_status":"IN PROGRESS",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_title":"ABC2",
"cas_custom_status":"",
"cas_init_user":"1",
"cas_create_date":"2016-06-01T16:18:59-07:00",
"cas_update_date":"2016-06-01 23:18:59", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html |
de4e0e0c281a-3 | "cas_finish_date":null,
"cas_assigned_status":"UNASSIGNED",
"cas_module":"Accounts",
"team_id":"1",
"team_set_id":"1",
"assigned_user_id":"1",
"assigned_user_name":"Administrator",
"prj_id":"6e025038-2842-11e6-b4f7-6c4008960436",
"prj_created_by":"1",
"prj_module":"Accounts",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"38beb03a-284f-11e6-b059-6c4008960436", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_InboxcasesList_GET/index.html |
de4e0e0c281a-4 | "pro_title":"PD1",
"prj_deleted":"0",
"prj_user_id_full_name":"Administrator",
"cas_user_id_full_name":"Sarah Smith"
},
}
}
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_InboxcasesList_GET/index.html |
ec8dd7e8aed4-0 | /Forecasts/:timeperiod_id/quotas/rollup/:user_id GET
ForecastsQuotasApi - Get
Summary:
This endpoint is used to return quota information for a specific user ID, in a specific timeperiod and by a specifc type..
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Required
quota_type
"rollup" or "direct" quota
Required
user_id
Show for a specific user
Required
Input Example:
Output Example:
{
"currency_id":"-99",
"amount":"75.000000",
"date_modified":"2013-09-17 21:23:32",
"formatted_amount":"$75.00",
"is_top_level_manager":true
} | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_idquotasrollupuser_id_GET/index.html |
ec8dd7e8aed4-1 | "is_top_level_manager":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/Forecaststimeperiod_idquotasrollupuser_id_GET/index.html |
d5a62b1c59cf-0 | /pmse_Project/ActivityDefinition/:record GET
Overview
Retrieves the definition data for an activity
Summary
This endpoint will retrieve the JSON encoded definition data for the Process
Definition activity identified by the record input parameter.
Request Arguments
Name
Type
Description
Required
record
String
The value for the act_uid field in the pmse_bpmn_activity record
True
Response Arguments
Name
Type
Description
success
Boolean
The status of the response
<field>
<value>
Field value in the pmse_bpmn_activity record
Response
{
"success":true,
"id":"566f0156-0ce3-75b4-da56-573cb73984aa",
"name":"Action # 1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-1 | "name":"Action # 1",
"date_entered":"2016-05-18 18:41:29",
"date_modified":"2016-05-18 18:42:00",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"pro_id":"9f8c4fcd-8d4c-949d-50b8-573caddf8c0c",
"act_type":"TASK",
"act_duration":"0",
"act_duration_unit":"DAYS",
"act_send_notification":"0",
"act_assignment_method":"balanced",
"act_assign_team":"",
"act_assign_user":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-2 | "act_assign_user":"",
"act_value_based_assignment":"",
"act_reassign":"0",
"act_reassign_team":"",
"act_adhoc":"0",
"act_adhoc_behavior":"",
"act_adhoc_team":"",
"act_response_buttons":"",
"act_last_user_assigned":"",
"act_field_module":"Accounts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-3 | "act_field_module":"Accounts",
"act_fields":"[{\u0022name\u0022:\u0022Assigned to\u0022,\u0022field\u0022:\u0022assigned_user_id\u0022,\u0022value\u0022:\u0022currentuser\u0022,\u0022type\u0022:\u0022user\u0022,\u0022label\u0022:\u0022Current user\u0022}]",
"act_readonly_fields":
[
{
"name":"phone_alternate",
"label":"Alternate Phone",
"readonly":false
},
{
"name":"annual_revenue",
"label":"Annual Revenue", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-4 | "name":"annual_revenue",
"label":"Annual Revenue",
"readonly":false
},
{
"name":"billing_address_city",
"label":"Billing City",
"readonly":false
},
{
"name":"billing_address_country",
"label":"Billing Country",
"readonly":false
},
{
"name":"billing_address_postalcode",
"label":"Billing Postal Code",
"readonly":false
},
{
"name":"billing_address_state",
"label":"Billing State",
"readonly":false
},
{
"name":"billing_address_street",
"label":"Billing Street",
"readonly":false | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-5 | "label":"Billing Street",
"readonly":false
},
{
"name":"created_by",
"label":"Created By",
"readonly":false
},
{
"name":"description",
"label":"Description",
"readonly":false
},
{
"name":"duns_num",
"label":"DUNS",
"readonly":false
},
{
"name":"employees",
"label":"Employees",
"readonly":false
},
{
"name":"facebook",
"label":"Facebook Account",
"readonly":false
},
{
"name":"phone_fax",
"label":"Fax",
"readonly":false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-6 | "label":"Fax",
"readonly":false
},
{
"name":"googleplus",
"label":"Google Plus ID",
"readonly":false
},
{
"name":"industry",
"label":"Industry",
"readonly":false
},
{
"name":"modified_user_id",
"label":"Modified By",
"readonly":false
},
{
"name":"name",
"label":"Name",
"readonly":false
},
{
"name":"phone_office",
"label":"Office Phone",
"readonly":false
},
{
"name":"ownership",
"label":"Ownership",
"readonly":false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-7 | "readonly":false
},
{
"name":"rating",
"label":"Rating",
"readonly":false
},
{
"name":"shipping_address_city",
"label":"Shipping City",
"readonly":false
},
{
"name":"shipping_address_country",
"label":"Shipping Country",
"readonly":false
},
{
"name":"shipping_address_postalcode",
"label":"Shipping Postal Code",
"readonly":false
},
{
"name":"shipping_address_state",
"label":"Shipping State",
"readonly":false
},
{
"name":"shipping_address_street",
"label":"Shipping Street", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-8 | "name":"shipping_address_street",
"label":"Shipping Street",
"readonly":false
},
{
"name":"sic_code",
"label":"SIC Code",
"readonly":false
},
{
"name":"ticker_symbol",
"label":"Ticker Symbol",
"readonly":false
},
{
"name":"twitter",
"label":"Twitter Account",
"readonly":false
},
{
"name":"account_type",
"label":"Type",
"readonly":false
},
{
"name":"website",
"label":"Website",
"readonly":false
}
],
"act_expected_time":
{
"time":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-9 | "act_expected_time":
{
"time":"",
"unit":"hour"
},
"act_required_fields":
[
{
"name":"phone_alternate",
"label":"Alternate Phone",
"required":false
},
{
"name":"annual_revenue",
"label":"Annual Revenue",
"required":false
},
{
"name":"billing_address_city",
"label":"Billing City",
"required":false
},
{
"name":"billing_address_country",
"label":"Billing Country",
"required":false
},
{
"name":"billing_address_postalcode",
"label":"Billing Postal Code", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-10 | "label":"Billing Postal Code",
"required":false
},
{
"name":"billing_address_state",
"label":"Billing State",
"required":false
},
{
"name":"billing_address_street",
"label":"Billing Street",
"required":false
},
{
"name":"created_by",
"label":"Created By",
"required":false
},
{
"name":"description",
"label":"Description",
"required":false
},
{
"name":"duns_num",
"label":"DUNS",
"required":false
},
{
"name":"employees",
"label":"Employees",
"required":false
}, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-11 | "label":"Employees",
"required":false
},
{
"name":"facebook",
"label":"Facebook Account",
"required":false
},
{
"name":"phone_fax",
"label":"Fax",
"required":false
},
{
"name":"googleplus",
"label":"Google Plus ID",
"required":false
},
{
"name":"industry",
"label":"Industry",
"required":false
},
{
"name":"modified_user_id",
"label":"Modified By",
"required":false
},
{
"name":"phone_office",
"label":"Office Phone",
"required":false
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-12 | "label":"Office Phone",
"required":false
},
{
"name":"ownership",
"label":"Ownership",
"required":false
},
{
"name":"rating",
"label":"Rating",
"required":false
},
{
"name":"shipping_address_city",
"label":"Shipping City",
"required":false
},
{
"name":"shipping_address_country",
"label":"Shipping Country",
"required":false
},
{
"name":"shipping_address_postalcode",
"label":"Shipping Postal Code",
"required":false
},
{
"name":"shipping_address_state",
"label":"Shipping State",
"required":false | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-13 | "label":"Shipping State",
"required":false
},
{
"name":"shipping_address_street",
"label":"Shipping Street",
"required":false
},
{
"name":"sic_code",
"label":"SIC Code",
"required":false
},
{
"name":"ticker_symbol",
"label":"Ticker Symbol",
"required":false
},
{
"name":"twitter",
"label":"Twitter Account",
"required":false
},
{
"name":"account_type",
"label":"Type",
"required":false
},
{
"name":"website",
"label":"Website",
"required":false
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_GET/index.html |
d5a62b1c59cf-14 | "label":"Website",
"required":false
}
],
"act_related_modules":[],
"act_service_url":null,
"act_service_params":null,
"act_service_method":null,
"act_update_record_owner":null,
"execution_mode":"DEFAULT",
"assigned_user_id":"",
"au_first_name":null,
"au_last_name":null,
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null
}
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_ProjectActivityDefinitionrecord_GET/index.html |
6524db41accc-0 | /<module>/:record/link/related_activities GET
Overview
Returns related activity records for a specified record.
Request Arguments
Name
Type
Description
Required
module_list
String
A list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included.Example:Meetings,Calls,Emails,Notes
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
max_num
String
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
deleted
Boolean | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html |
6524db41accc-1 | False
deleted
Boolean
Boolean to show deleted records in the result set. Default is false.
False
alias_fields
Array
A list of field aliases from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be fetched. These field aliases can also be used in 'order_by'. Example:Â { 'record_date': { 'Calls': 'date_start', 'Emails': 'date_sent' } }
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":[
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html |
6524db41accc-2 | Response
{
next_offset":-1,
"records":[
{
"id":"2f9abe52-f03f-11e9-858c-3c15c2d57622",
"name":"test call",
"date_entered":"2019-10-16T11:02:57-07:00",
"date_modified":"2019-10-16T11:02:57-07:00",
"description":"",
"date_start":"2019-10-25T11:30:00-07:00",
"status":"Planned",
"contact_name":"",
"contacts":{
"name":"",
"id":"",
"_acl":{
"fields":[
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html |
6524db41accc-3 | "id":"",
"_acl":{
"fields":[
],
"_hash":"654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"contact_id":"",
"locked_fields":[
],
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html |
6524db41accc-4 | "create":"no"
}
},
"delete":"no",
"_hash":"08b99a97c2e8d792f7a44d8882b5af6d"
}
},
"_acl":{
"fields":{
}
},
"_module":"Calls",
"moduleNameSingular":"Call",
"moduleName":"Calls"
},
]
}
Change Log
Version
Change
v11.7
Added /<module>/:record/link/related_activities 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/modulerecordlinkrelated_activities_GET/index.html |
9dda8713f7d6-0 | /<module>/:record/link/history GET
Overview
Lists history filtered records.
Summary
This endpoint will return a set of history modules (meetings, calls, notes, tasks, emails) records filtered by an expression.
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
order_by
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkhistory_GET/index.html |
9dda8713f7d6-1 | False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
module_list
String
A list of modules from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be included
False
alias_fields
Array | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkhistory_GET/index.html |
9dda8713f7d6-2 | False
alias_fields
Array
A list of field aliases from the valid modules [Tasks, Calls, Emails, Notes, Meetings] that need to be fetched. These field aliases can also be used in 'order_by'.
Example:
{
'record_date':
{
'Calls': 'date_start',
'Emails': 'date_sent'
}
}
False
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/modulerecordlinkhistory_GET/index.html |
cd0fa98db196-0 | /<module>/:record/link/:link_name/filter/leancount GET
Overview
Lists related filtered records.
Summary
This endpoint will return a set of related records filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Care will need to be taken to make sure this filter has
appropriate indexes on the server side otherwise the runtime of the endpoint will be very long. Related fields can
be searched by specifying the field name as: "link_name.remote_field", so if you wished to search the Accounts
module by a related member account you would use "members.sic_code".
Request Arguments
Name
Type
Description
Required
filter
String
The filter expression. Filter expressions are explained below.
False
max_num
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-1 | False
max_num
Integer
A maximum number of records to return. Default is 20.
False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. The field date_modified will always be returned. This argument
can be combined with the view argument.
Example: name,account_type,description
False
view
String
Instead of defining the fields argument, the view argument can be used instead. The field list is
constructed at the server side based on the view definition which is requested. This argument can be used | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-2 | in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String
How to sort the returned records, in a comma delimited list with the direction appended to the column name
after a colon.
Example: name:DESC,account_type:DESC,date_modified:ASC
False
Filter Expressions
There are four types of filters:
Basic
This will filter the results by checking the field "name" for value "Nelson Inc". This will only find exact matches.
Example
{
"filter":[
{
"name":"Nelson Inc"
}
]
}
Full
This expression allows you to specify what operation you want to use for filtering on the field. In the example you | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-3 | would match any record where the field "name" starts with the value "Nelson".
Example
{
"filter":[
{
"name":{
"$starts":"Nelson"
}
}
]
}
Below is a list of operation types:
Operation
Description
$equals
Performs an exact match on that field.
$not_equals
Performs an exact match on that field.
$not_equals
Matches on non-matching values.
$starts
Matches on anything that starts with the value.
$ends
Matches anything that ends with the value.
$contains
Matches anything that contains the value | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-4 | $contains
Matches anything that contains the value
$in
Finds anything where field matches one of the values as specified as an array.
$not_in
Finds anything where field does not matches any of the values as specified as an array.
$is_null
Checks if the field is null. This operation does not need a value specified.
$not_null
Checks if the field is not null. This operation does not need a value specified.
$lt
Matches when the field is less than the value.
$lte
Matches when the field is less than or equal to the value.
$gt
Matches when the field is greater than the value. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-5 | Matches when the field is greater than the value.
$gte
Matches when the field is greater than or equal to the value.
Sub-expressions
This allows you to group filter expressions into or/and groupings. By default all expressions are and'ed together.
The example expression would match if the field "name" was either "Nelson Inc" or "Nelson LLC". The only currently
accepted sub-expression types are "$and" and "$or".
Example
{
"filter":[
{
"$or":[
{
"name":"Nelson Inc"
},
{
"name":"Nelson LLC"
}
]
}
]
}
Modules | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-6 | }
]
}
]
}
Modules
There are two module expressions, they operate on modules instead of fields. The current module can be specified by
either using the module name "_this" or by leaving the module name as a blank string. The example expression would
filter the records in the current module to only your favorites. The only currently accepted module expressions are
"$favorite" and "$owner".
Example
{
"filter":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-7 | Array
An array of results containing matched records.
Repsonse
{
"next_offset":-1,
"records":[
{
"id":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"name":"Dale Spivey",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-28T05:03:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-8 | "description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Dale",
"last_name":"Spivey", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-9 | "last_name":"Spivey",
"full_name":"Dale Spivey",
"title":"VP Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(523) 825-4311",
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-10 | "invalid_email":"0",
"primary_address":"0"
}
],
"phone_mobile":"(373) 861-0757",
"phone_work":"(212) 542-9596",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"345 Sugar Blvd.",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-11 | "primary_address_state":"CA",
"primary_address_postalcode":"87261",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Campaign",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-12 | "opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"DaleSpivey97",
"portal_active":true,
"portal_password":"$1$yKMAONHM$Y5S.8CY.WZCZCwfGD1a1Q\/",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-13 | "accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
{
"id":"95e17367-9b3d-0e26-22dc-512d0961fedf",
"name":"Florence Haddock",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-14 | "created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Florence", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-15 | "salutation":"",
"first_name":"Florence",
"last_name":"Haddock",
"full_name":"Florence Haddock",
"title":"Director Sales",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(729) 845-3137",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-16 | "opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382",
"phone_work":"(565) 696-6981",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"111 Silicon Valley Road",
"primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Denver",
"primary_address_state":"CA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-17 | "primary_address_state":"CA",
"primary_address_postalcode":"79900",
"primary_address_country":"USA",
"alt_address_street":"",
"alt_address_street_2":"",
"alt_address_street_3":"",
"alt_address_city":"",
"alt_address_state":"",
"alt_address_postalcode":"",
"alt_address_country":"",
"assistant":"",
"assistant_phone":"",
"picture":"",
"email_and_name1":"",
"lead_source":"Support Portal User Registration",
"account_name":"Smallville Resources Inc",
"account_id":"d5db6292-5c24-eb61-e202-512d09f0134e", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-18 | "opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"FlorenceHaddock169",
"portal_active":true,
"portal_password":"$1$nWFhTbK6$JF9BCGSqL\/NCrbhueX5ia0",
"portal_password1":"",
"portal_app":"",
"preferred_language":"en_us",
"campaign_id":"",
"campaign_name":"",
"c_accept_status_fields":"",
"m_accept_status_fields":"",
"accept_status_id":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
cd0fa98db196-19 | "accept_status_id":"",
"accept_status_name":"",
"sync_contact":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/filter GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilterleancount_GET/index.html |
46b3a48c19d0-0 | /<module>/insertbefore/:target POST
Overview
Insert new node before target node.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
target
String
The ID of record that will be used as target to insert new node before
True
Request
{
"name" : "Children Node 1"
}
Response Arguments
This endpoint does not return any response arguments.
Response
This endpoint returns a newly created bean
{
"my_favorite":false,
"following":"",
"id":"59fa8dd7-0f2c-4bfd-364f-54495f77fa3f", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html |
46b3a48c19d0-1 | "name":"Default title",
"date_entered":"2014-10-23T23:03:22+03:00",
"date_modified":"2014-10-23T23:03:22+03:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"doc_owner":"",
"description":"",
"deleted":false,
"source_id":"",
"source_type":"",
"source_meta":"",
"root":"be9b0c4a-8b78-1ffa-4f14-54481c2f6269",
"lft":118,
"rgt":119, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduleinsertbeforetarget_POST/index.html |
46b3a48c19d0-2 | "lft":118,
"rgt":119,
"level":1,
"_acl":{"fields":{}},
"_module":"Categories"
}
Change Log
Version
Change
v10
Added /<module>/insertbefore/: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/moduleinsertbeforetarget_POST/index.html |
ffa18267e2a5-0 | /<module>/:record GET
Overview
Retrieves a record.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
ffa18267e2a5-1 | "created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West",
"name_2":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
ffa18267e2a5-2 | "name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019",
"billing_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
ffa18267e2a5-3 | "billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019",
"shipping_address_country":"USA", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
ffa18267e2a5-4 | "shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
ffa18267e2a5-5 | ],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecord_GET/index.html |
0375b036f170-0 | /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/globalsearch_POST/index.html |
0375b036f170-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/globalsearch_POST/index.html |
0375b036f170-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/globalsearch_POST/index.html |
0375b036f170-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/globalsearch_POST/index.html |
11f01b02db40-0 | /help GET
Overview
Fetches the help documentation
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<html>
String
Returns the html of the help doc
Response
The HTML for this help document.
Change Log
Version
Change
v10
Added /help 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/help_GET/index.html |
86869d586038-0 | /<module>/:record/favorite DELETE
Overview
Removes a record of a specified type as a favorite for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
86869d586038-1 | "modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"last_activity_date":"2013-02-26T19:12:00+00:00",
"deleted":false,
"assigned_user_id":"seed_max_id",
"assigned_user_name":"Max Jensen",
"team_name":[
{
"id":"East",
"name":"East",
"name_2":"",
"primary":false
},
{
"id":1,
"name":"Global",
"name_2":"",
"primary":false
},
{
"id":"West",
"name":"West", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
86869d586038-2 | },
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"account_type":"Customer",
"industry":"Electronics",
"annual_revenue":"",
"phone_fax":"",
"billing_address_street":"345 Sugar Blvd.",
"billing_address_street_2":"",
"billing_address_street_3":"",
"billing_address_street_4":"",
"billing_address_city":"San Mateo",
"billing_address_state":"CA",
"billing_address_postalcode":"56019", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
86869d586038-3 | "billing_address_postalcode":"56019",
"billing_address_country":"USA",
"rating":"",
"phone_office":"(927) 136-9572",
"phone_alternate":"",
"website":"www.sectionvegan.de",
"ownership":"",
"employees":"",
"ticker_symbol":"",
"shipping_address_street":"345 Sugar Blvd.",
"shipping_address_street_2":"",
"shipping_address_street_3":"",
"shipping_address_street_4":"",
"shipping_address_city":"San Mateo",
"shipping_address_state":"CA",
"shipping_address_postalcode":"56019", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
86869d586038-4 | "shipping_address_postalcode":"56019",
"shipping_address_country":"USA",
"email1":"[email protected]",
"parent_id":"",
"sic_code":"",
"parent_name":"",
"email_opt_out":false,
"invalid_email":false,
"email":[
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"0"
}
], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
86869d586038-5 | "primary_address":"0"
}
],
"campaign_id":"",
"campaign_name":"",
"my_favorite":false,
"_acl":{
"fields":{
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/favorite DELETE endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_DELETE/index.html |
f57b42676707-0 | /<module>/:record/favorite PUT
Overview
Updates a record of a specified type as a favorite for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
<record field>
<record field type>
Returns the fields for the selected record.
Response
{
"id":"bdd59d85-687b-1739-b00a-512d09f6db9e",
"name":"Insight Marketing Inc",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordfavorite_PUT/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.