id
stringlengths 14
16
| text
stringlengths 33
5.27k
| source
stringlengths 105
270
|
|---|---|---|
909f1a007234-0 | /<module>/:record/link/:link_name/filter 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
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
in combination with the fields argument. Common views are "record" and "list".
Example: record
False
order_by
String | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-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
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.
$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. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-2 | $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.
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":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-3 | ]
}
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.
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,
"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_namefilter_GET/index.html |
909f1a007234-4 | "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]",
"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.",
"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":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-5 | "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",
"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":"",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-6 | "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
},
{
"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",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(246) 233-1382", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-7 | ],
"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",
"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",
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_namefilter_GET/index.html |
909f1a007234-8 | "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>/: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_namefilter_GET/index.html |
c4a476a0b466-0 | /Administration/idm/users GET
Overview
Lists filtered user records.
Summary
This endpoint will return a set of user records with raw password hashes 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
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
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html |
c4a476a0b466-1 | 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
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
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
Filter Expressions | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html |
c4a476a0b466-2 | 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.
$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
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/Administrationidmusers_GET/index.html |
c4a476a0b466-3 | $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"
},
{
"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
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/Administrationidmusers_GET/index.html |
c4a476a0b466-4 | Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"records": [
{
"id": "1",
"user_name": "admin",
"user_hash": "$2y$10$PXY1UPZHjcm.t6ZArbia0uVzjCNEDm0XcGu/whGGk2xaPzAEKrKLa",
"system_generated_password": false,
"pwd_last_changed": "",
"authenticate_id": "",
"sugar_login": true,
"picture": "7772d3b4-5779-11e8-835a-6a00025a7f70",
"first_name": "",
"last_name": "Administrator",
"full_name": "Administrator",
"name": "Administrator",
"is_admin": true,
"external_auth_only": false,
"receive_notifications": true,
"description": "",
"date_entered": "2018-05-14T16:19:36+03:00",
"date_modified": "2018-05-14T16:27:43+03:00",
"last_login": "2018-05-16T12:12:43+03:00",
"modified_user_id": "1",
"modified_by_name": "",
"created_by": "",
"created_by_name": "",
"created_by_link": {
"full_name": "",
"id": "",
"_acl": {
"fields": [], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html |
c4a476a0b466-5 | "id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"title": "Administrator",
"department": "",
"phone_home": "",
"phone_mobile": "",
"phone_work": "",
"phone_other": "",
"phone_fax": "",
"status": "Active",
"address_street": "",
"address_city": "",
"address_state": "",
"address_country": "",
"address_postalcode": "",
"UserType": "",
"default_team": "1",
"team_count": "",
"team_count_link": {
"team_count": "",
"id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"team_name": [
{
"id": "1",
"name": "Global",
"name_2": "",
"primary": false,
"selected": false
}
],
"deleted": false,
"portal_only": false,
"show_on_employees": true,
"employee_status": "Active",
"messenger_id": "",
"messenger_type": "",
"reports_to_id": "",
"reports_to_name": "",
"reports_to_link": {
"name": "",
"id": "",
"_acl": {
"fields": [], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html |
c4a476a0b466-6 | "id": "",
"_acl": {
"fields": [],
"_hash": "654d337e0e912edaa00dbb0fb3dc3c17"
}
},
"email1": "",
"email": [
{
"email_address": "[email protected]",
"primary_address": true,
"reply_to_address": false,
"invalid_email": false,
"opt_out": false,
"email_address_id": "93634e90-577a-11e8-a2f0-6a00025a7f70"
}
],
"email_link_type": "",
"is_group": false,
"c_accept_status_fields": "",
"calls": {
"id": ""
},
"m_accept_status_fields": "",
"meetings": {
"id": ""
},
"accept_status_id": "",
"accept_status_name": "",
"accept_status_calls": "",
"accept_status_meetings": "",
"preferred_language": "",
"acl_role_set_id": "",
"my_favorite": false,
"_acl": {
"delete": "no",
"fields": {
"pwd_last_changed": {
"write": "no",
"create": "no"
},
"last_login": {
"write": "no",
"create": "no"
}
}
},
"_module": "Users"
}
]
}
Change Log
Version
Change
v11_2
Added /Administration/idm/users GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Administrationidmusers_GET/index.html |
c4a476a0b466-7 | Added /Administration/idm/users 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/Administrationidmusers_GET/index.html |
cd5f66429d5d-0 | /Users/:record DELETE
Delete a User and return its ID
Summary:
This endpoint is used to delete a User. Returns the ID of the deleted User.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecord_DELETE/index.html |
7f7f63fc8803-0 | /pmse_Inbox/case/:id/:idflow GET
Overview
Retrieve information of the process record
Summary
This endpoint gets information for a process record
Request Arguments
Name
Type
Description
Required
id
string
The id of the process requiring action
true
idflow
string
The id of the process trigger sequence
true
Response Arguments
Name
Type
Description
case
object
Process record
Response
{
"case":
{
"flow":
{
"id":"b2d418ba-28ef-11e6-8ae6-6c4008960436",
"name":"",
"date_entered":"2016-06-02 18:27:42",
"date_modified":"2016-06-02 18:27:42",
"modified_user_id":"1",
"created_by":"1",
"description":null,
"deleted":"0",
"cas_id":"3",
"cas_index":"3",
"pro_id":"6e172e2c-2842-11e6-a4bb-6c4008960436",
"cas_previous":"2",
"cas_reassign_level":"0",
"bpmn_id":"7c62acc2-2842-11e6-9b9c-6c4008960436",
"bpmn_type":"bpmnActivity",
"cas_assignment_method":"static",
"cas_user_id":"1",
"cas_thread":"1",
"cas_flow_status":"FORM",
"cas_sugar_module":"Accounts", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html |
7f7f63fc8803-1 | "cas_flow_status":"FORM",
"cas_sugar_module":"Accounts",
"cas_sugar_object_id":"b2103fd0-28ef-11e6-8916-6c4008960436",
"cas_sugar_action":"None",
"cas_adhoc_type":"",
"cas_adhoc_parent_id":"",
"cas_adhoc_actions":"[\u0022link_cancel\u0022,\u0022approve\u0022,\u0022reject\u0022,\u0022edit\u0022]",
"cas_task_start_date":null,
"cas_delegate_date":"2016-06-02 18:27:42",
"cas_start_date":null,
"cas_finish_date":null,
"cas_due_date":null,
"cas_queue_duration":"0",
"cas_duration":"0",
"cas_delay_duration":"0",
"cas_started":"0",
"cas_finished":"0",
"cas_delayed":"0",
"assigned_user_id":"1",
"au_first_name":null,
"au_last_name":"Administrator",
"cbu_first_name":null,
"cbu_last_name":"Administrator",
"mbu_first_name":null,
"mbu_last_name":"Administrator",
"my_favorite":null
},
"reclaim":false,
"buttons":
[
{
"type":"button",
"name":"cancel_button",
"label":"Cancel",
"css_class":"btn-invisible btn-link",
"showOn":"edit",
"events":
{
"click":"button:cancel_button:click"
}
},
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html |
7f7f63fc8803-2 | }
},
{
"type":"rowaction",
"event":"case:approve",
"name":"approve_button",
"label":"Approve",
"css_class":"btn btn-success"
},
{
"type":"rowaction",
"event":"case:reject",
"name":"reject_button",
"label":"Reject",
"css_class":"btn btn-danger"
},
{
"type":"actiondropdown",
"name":"main_dropdown",
"primary":true,
"showOn":"view",
"buttons":
[
{
"type":"rowaction",
"event":"button:edit_button:click",
"name":"edit_button",
"label":"Edit",
"acl_action":"edit"
},
{
"type":"rowaction",
"name":"history",
"label":"History",
"event":"case:history"
},
{
"type":"rowaction",
"name":"status",
"label":"Status",
"event":"case:status"
},
{
"type":"rowaction",
"name":"add-notes",
"label":"Show Notes",
"event":"case:add:notes"
}
]
}
],
"readonly":[],
"required":[],
"title":
{
"time":
{
"expected_time_warning":false,
"expected_time_message":false,
"expected_time_view":false,
"expected_time":""
},
"process":"PD1",
"rec_name":"ABC3", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_Inboxcaseididflow_GET/index.html |
7f7f63fc8803-3 | },
"process":"PD1",
"rec_name":"ABC3",
"activity":"Activity # 1"
},
"inboxId":"b2b6e20e-28ef-11e6-bba8-6c4008960436",
"flowId":"b2d418ba-28ef-11e6-8ae6-6c4008960436"
}
}
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_Inboxcaseididflow_GET/index.html |
bd5a39ebbdf1-0 | /me/preferences GET
Overview
Returns all the current user's stored preferences.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preferences 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/mepreferences_GET/index.html |
b899118638ab-0 | /theme POST
Overview
Updates the variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments.
Request Arguments
Name
Type
Description
Required
platform
String
The theme platform - /themes/clients/***PLATFORM***/themeName/. Accepted values are 'base' and 'portal'.
True
themeName
String
The theme name - /themes/clients/platform/***THEMENAME***/.
True
<theme variable>
String
The variables of the theme
False
Request
{
platform:'portal',
themeName:'default',
primary:'default',
secondary:'#aaaaaa',
primaryBtn:'#bbbbbb',
}
Response Arguments
Name
Type
Description
<css path>
String
Returns the path of the new bootstrap.css file.
Response
"http:\/\/sugarcrm\/cache\/themes\/clients\/base\/default\/6a031485bf5239b9462e4aaba72a4646.css"
Change Log
Version
Change
v10
Added /<theme> 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/theme_POST/index.html |
81553d2ad35d-0 | /Meetings/:record/external GET
Retrieves info about launching an external meeting
Summary:
This endpoint is used to retrieve info about launching an external meeting. This includes whether the current user
has permission to host and/or join the meeting along with the host/join URLs.
Query Parameters:
Param
Description
Optional
This endpoint does not accept any parameters.
Input Example:
Output Example:
{
"is_host_option_allowed": false,
"host_url": "",
"is_join_option_allowed": true,
"join_url": "//link.to/external/meeting"
}
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/Meetingsrecordexternal_GET/index.html |
8fea0d986611-0 | /Reports/:record/:type GET
Overview
An API to run a saved report and export the result.
Summary
This endpoint will export the result of a saved report in one of the following formats: pdf, base64, csv, and json ('rows and columns' reports only).
Request Arguments
Name
Type
Description
Required
record
String
ID of a saved report
True
export_type
String
Format of exported data. It can be one of the following formats: pdf, base64, csv, and json. CSV and JSON export types are only currently available for 'Rows and Columns' reports.
True
Request Example
GET /rest/v11/Reports/:id/json
Response Example
[
{
"Contact ID":"fa300a0e-0ad1-b322-9601-512d0983c19a",
"First Name":"Dale",
"Last Name":"Arvizu",
"Email Address":"[email protected]",
"Account Name":"DD Furniture Inc"
},
{
"Contact ID":"71c773ce-980e-11eb-8f85-f45c898a3ce7",
"First Name":"Isis",
"Last Name":"Arvizu",
"Email Address":"[email protected]",
"Account Name":"J.K.M. Corp (HA)"
},
]
Â
Change Log
Version
Change
v11.13
Added csv and json formats.
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/Reportsrecordtype_GET/index.html |
3aa3ed7581c3-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
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":[
{
"id":"2f9abe52-f03f-11e9-858c-3c15c2d57622",
"name":"test call",
"date_entered":"2019-10-16T11:02:57-07:00", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkrelated_activities_GET/index.html |
3aa3ed7581c3-1 | "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":[
],
"_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",
"_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 |
b4fc6c75d11e-0 | /TimePeriods 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
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
A maximum number of records to return. Default is 20.
False
offset
Integer | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html |
b4fc6c75d11e-1 | 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
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html |
b4fc6c75d11e-2 | 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
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
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/TimePeriods_GET/index.html |
b4fc6c75d11e-3 | $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.
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":[
{
"$favorite":"_this"
}
]
}
Response Arguments
Name
Type
Description
next_offset | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html |
b4fc6c75d11e-4 | ]
}
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_modified":"2013-02-28T05:03:00+00:00",
"description":"",
"opportunities": [
{
_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": [
{
_module: "Opportunities" | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/TimePeriods_GET/index.html |
b4fc6c75d11e-5 | {
_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/TimePeriods_GET/index.html |
9bd41b44fa96-0 | /bulk POST
Overview
Run API calls in bulk.
Summary
This request will run a sequence of API requests within one query. The requests are executed sequentially and their results
are returned as one response. Some requests may return failure code, that does not interrupt the execution of the batch,
and the overall request will still be considered successful.
Request Arguments
Name
Type
Description
Required
requests
Array
The list of requests
True
Each of the requests can have the following fields:
Name
Type
Description
Required
url
String
The request URL, starting with version.
True
data
JSON String
The data for the POST/PUT body. Must be a JSON-encoded string.
False
headers
Array
The request headers
False
method
String
The HTTP method (default is GET)
False
Request Example
{"requests":
[
{
"url": "/v10/Accounts", "method": "POST", "data": "{\"name\": \"test123\"}"
},
{
"url": "/v10/Accounts", "method": "GET"
}
]
}
Response
The response will contain an array of response objects, each of them will correspond to the individual request. The following fields are in the response objects:
Name
Type
Description
contents
Array or String
The response contents, can be JSON object or string depending on what the individual request is supposed to return.
headers
Array | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/bulk_POST/index.html |
9bd41b44fa96-1 | headers
Array
The response headers
status
Integer
HTTP status code of the response. Will be 2XX for successful requests and 4XX or 5XX for errors.
Response Example
[
{
"contents": {
"my_favorite": false,
"following": true,
"id": "7d2e21a6-8a76-a74f-bb53-535620211304",
"name": "test123",
"date_entered": "2014-04-22T03:56:24-04:00",
"_module": "Accounts"
},
"headers": [],
"status": 200
},
{
"contents": {
"next_offset": -1,
"records": [
{
"my_favorite": false,
"following": true,
"id": "7d2e21a6-8a76-a74f-bb53-535620211304",
"name": "test123",
"date_entered": "2014-04-22T03:56:24-04:00",
"date_modified": "2014-04-22T03:56:24-04:00",
}
]
},
"headers": [],
"status": null
}
]
Change Log
Version
Change
v10
Added /bulk 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/bulk_POST/index.html |
3c3cba9ffbfe-0 | /Administration/search/fields GET
Overview
[ADMIN] Search field configuration
Summary
This endpoint lists the full text search configuration of all fields for the full text search enabled modules. This
endpoint is only available to administrators.
Request Arguments
Name
Type
Description
Required
module_list
String
Comma delimited list of modules to return. If omitted, all search enabled modules will be returned.
Example: Accounts,Contacts
False
search_only
Boolean
When set, only searchable fields are returned. Defaults to false.
False
order_by_boost
Boolean
When set, a flat list of searchable fields is returned ordered by boost value.
False
Response
{
"Accounts":{
"name":{
"name":"name",
"type":"name",
"searchable":true,
"boost":1
},
"date_modified":{
"name":"date_modified",
"type":"datetime",
"searchable":false
}
}
}
Response using order_by_boost
{
"Quotes.quote_num":1.5,
"Manufacturers.name":1,
"Bugs.name":0.9,
"ProjectTask.name":0.5,
}
Change Log
Version
Change
v10
Added /Administration/search/fields 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/Administrationsearchfields_GET/index.html |
075bfc44be78-0 | /Dashboards/:id/restore-metadata PUT
Overview
Restores the metadata for a module's dashboard to the default metadata.
Summary
This endpoint is used to restore the default metadata for a module's dashboard.
Request Arguments
Name
Type
Description
Required
dashboard_module
string
The module dashboard belongs to (e.g. Home, Cases, Accounts)
True
dashboard
string
The dashboard name (e.g. portal-home)
True
Request
{
"dashboard_module":"Home",
"dashboard":"portal-home"
}
Â
Response Example
{
"id":"123",
"name":"LBL_PORTAL_HOME",
"dashboard_module": "Home",
"view_name": "home",
"metadata": {
"css_class": "portal-home-dashboard"
"components": {...},
},
...
}
Change Log
Version
Change
v11.13
Added /Dashboards/<id>/restore-metadata PUT endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboardsidrestoremetadata_PUT/index.html |
002a47b075cc-0 | /<module>/:record/children GET
Overview
Retrieves all children of selected record.
Request Arguments
Name
Type
Description
Required
module
String
The name of sugar module that contains a nested set data and implements the NestedSetInterface.
True
:record
String
The ID of record
True
Response Arguments
This endpoint does not return any response arguments.
Response
[{
"id": "045c1de6-327b-11e4-818b-5404a67f3363",
"name": "Financial",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "11",
"rgt": "14",
"level": "2"
}, {
"id": "0f65a6c7-327b-11e4-818b-5404a67f3363",
"name": "Agreements",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordchildren_GET/index.html |
002a47b075cc-1 | "source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "15",
"rgt": "16",
"level": "2"
}, {
"id": "14d30bf3-327b-11e4-818b-5404a67f3363",
"name": "Clients",
"date_entered": null,
"date_modified": null,
"modified_user_id": null,
"created_by": null,
"description": null,
"deleted": "0",
"source_id": null,
"source_type": null,
"source_meta": null,
"root": "935d3e07-327a-11e4-818b-5404a67f3363",
"lft": "17",
"rgt": "18",
"level": "2"
}]
Change Log
Version
Change
v10
Added /<module>/:record/children 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/modulerecordchildren_GET/index.html |
c8d2f450f93c-0 | /connectors GET
Overview
Gets general info about connectors.
Request Arguments
This endpoint does not accept any request arguments.
Result Arguments
Response
{
"connectors": {
"ext_rest_twitter": {
"testing_enabled": true,
"test_passed": false,
"eapm_bean": false,
"field_mapping": {
"beans": {
"Accounts": {
"name": "name",
"id": "id"
},
"Contacts": {
"name": "full_name",
"id": "id"
},
"Leads": {
"name": "account_name",
"id": "id"
},
"Prospects": {
"name": "account_name",
"id": "id"
}
}
},
"id": "ext_rest_twitter",
"name": "Twitter"
},
"ext_eapm_google": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_google",
"name": "Google"
},
"ext_eapm_gotomeeting": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_gotomeeting",
"name": "GoToMeeting"
},
"ext_eapm_ibmsmartcloud": {
"testing_enabled": false,
"test_passed": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html |
c8d2f450f93c-1 | "testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_ibmsmartcloud",
"name": "IBM SmartCloud"
},
"ext_eapm_webex": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_webex",
"name": "WebEx"
},
"ext_eapm_lotuslive": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": [],
"id": "ext_eapm_lotuslive",
"name": "LotusLive"
},
"ext_rest_dnb": {
"testing_enabled": false,
"test_passed": false,
"eapm_bean": false,
"field_mapping": {
"beans": {
"Accounts": {
"name": "name",
"id": "id"
}
}
},
"id": "ext_rest_dnb",
"name": "DNB"
},
"_hash": "\u0000d4751e1632fd5d1d2c9069a1f176e6f"
},
"_hash": "2cd9132603ead4f79715c69ee98e64f1"
}
Change Log
Version
Change
v10
Added /<connectors> GET endpoint. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/connectors_GET/index.html |
c8d2f450f93c-2 | v10
Added /<connectors> 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/connectors_GET/index.html |
f529c114656e-0 | /Administration/aws GET
Overview
[ADMIN] Gets Amazon Web Services configs from Sugar Serve.
Summary
This endpoint gets configuration values for Amazon Web Services. This endpoint is only available to administrators of Sugar Serve.
Request Arguments
This endpoint does not accept any arguments.
Response
{
"aws_connect_instance_name": "my-aws-instance",
"aws_connect_region": "us-east-2"
}
Change Log
Version
Change
v11_10
Added /Administration/aws 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/Administrationaws_GET/index.html |
980b3f60cc61-0 | /Dashboards GET
Overview
List current user's filtered Home dashboards.
Summary
This endpoint will return a set of Home dashboards filtered by an expression. The filter can be applied to multiple
fields and have multiple and/or conditions in it. Alternatively, you may use an existing filter by specifying its
id. If both a filter definition and a filter id are passed, the two filters will be joined with an AND.
Care will need to be taken to make sure that any filters used have appropriate indexes on the server side otherwise
the runtime of the endpoint will be very long.
Notice
The behavior of this endpoint has changed in v11. For a description of behavior in v11, refer to
GET /<module>. If you continue to use v10 of the API,
your REST calls should behave as before. But, it is advisable to upgrade to v11. Slight differences exist in
the GET method of v10 vs v11.Migrating to v11:
Recommended Replacement:
GET /Dashboards
The Home module is no longer the default dashboard_module. To get the Home module
dashboard, include the following filter parameter.v11:
GET /Dashboards?filter[0][dashboard_module]=Home
name, id. etc. are no longer specified as default fields. To retain the default fields, usev11:
GET /Dashboards?filter[0][dashboard_module]=Home&fields=id,name,view_name
Request Arguments
Name
Type
Description
Required
filter
String
See Filter API.
False
filter_id
String
Identifier for a preexisting filter. See
the Filter API for details.
False
max_num
Integer
Max number of records that can be returned. Default is 20, unless overruled by your Sugar configuration. | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html |
980b3f60cc61-1 | False
offset
Integer
The number of records to skip over before records are returned. Default is 0.
False
fields
String
Comma delimited list of fields to return. Each field may be represented either by string, or by map
containing field name and additional field parameters (applicable to link and collection fields).
The fields id and date_modified will always be returned.
For more details on additional field parameters, see
Relate API and
Collection API.
False
order_by
String
See Filter API.
False
deleted
Boolean
Boolean to show deleted records in the result set.
False
Response Arguments
Name
Type
Description
next_offset
Integer
Displays the next offset for retrieval of additional results. -1 will be returned when there are no more
records.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"records": [
{
"id": "c630c772-faca-2051-6a42-56fab2e73e42",
"name": "New Home Dashboard",
"date_modified": "2016-03-29T09:49:06-07:00",
"view_name": "",
"_acl": {
"fields": {}
},
"view": "",
"_module": "Dashboards"
},
{
"id": "15677f2c-f00d-c59a-6fbe-56fab1f33732",
"name": "Home Dashboard2",
"date_modified": "2016-03-29T09:47:25-07:00",
"view_name": "",
"_acl": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html |
980b3f60cc61-2 | "view_name": "",
"_acl": {
"fields": {}
},
"view": "",
"_module": "Dashboards"
},
{
"id": "d509b3da-29f6-7b23-7cce-56fab1a6335b",
"name": "Accounts Dashboard",
"date_modified": "2016-03-29T09:46:00-07:00",
"view_name": "records",
"_acl": {
"fields": {}
},
"view": "records",
"_module": "Dashboards"
},
{
"id": "cc4982cd-0bdf-bad4-d079-56fab4bdddf1",
"name": "Activity Stream Dashboard",
"date_modified": "2016-03-29T09:57:58-07:00",
"view_name": "activities",
"_acl": {
"fields": {}
},
"view": "activities",
"_module": "Dashboards"
}
]
}
Change Log
Version
Change
v11
Behavior has changed. Please see GET /Dashboards
for the designated replacement.
v10
Added /Dashboards GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Dashboards_GET/index.html |
6dcd3d280ea5-0 | /Emails/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing email.
Summary
Cannot link existing Notes records as attachments (link: attachments) and existing EmailParticipants records
as a sender (link: from) or recipients(links: to, cc, bcc). All other operations
described in Relate Record API are supported.
Change Log
Version
Change
v10
Added /Emails/:record/link/:link_name/:remote_id POST endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsrecordlinklink_nameremote_id_POST/index.html |
40f07dc83c06-0 | /ProductTemplates/tree POST
ProductTemplate API
Summary:
This endpoint is designed to return a paged recordset of one level of product templates and product categories in
a N-level deep tree representing the relationship between categories and templates. The results are loosely
filtered (wildcard before and after).
Query Parameters:
Param
Description
Optional
filter
The filter used to search Product Template and Product Category names. %filter%
true
root
The ID of the root node you wish to retrieve. Defaults to null (the root level)
true
offset
Specifies the numeric value of the offset you wish to retrieve
true
max_num
Specifies the numeric value of the max number of records you wish to receive. Default is 20.
true
Response Parameters:
Param
Description
id
The id of the item (Product Category/Template)
Data
The name of the item
state
Specifies the open or closed state of the element. (used for categories)
index
Specifies the index of this element in the current level.
Response:
{
"records":[
{
"id":"023d316a-d9d0-11e7-9f54-02425392a518",
"type":"category",
"data":"Christen Widgets",
"state":"closed",
"index":0
},
{
"id":"01828a4a-d9d0-11e7-8989-02425392a518",
"type":"category",
"data":"Desktops",
"state":"closed",
"index":1
}
],
"next_offset":2
}
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/ProductTemplatestree_POST/index.html |
10b34bdee14a-0 | /Users/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing record.
Query String Parameters
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record linked to the related record.
related_record
Array
The record that was 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":"",
"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/Usersrecordlinklink_nameremote_id_POST/index.html |
10b34bdee14a-1 | "opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html |
10b34bdee14a-2 | "deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html |
10b34bdee14a-3 | "primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"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":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"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":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Usersrecordlinklink_nameremote_id_POST/index.html |
10b34bdee14a-4 | "my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/: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/Usersrecordlinklink_nameremote_id_POST/index.html |
8c642322a399-0 | /Leads/:record/freebusy GET
Get a lead's FreeBusy schedule
Summary:
This endpoint returns a list of time slots for which the specified person is busy.
Request
GET /Leads/:id/freebusy
Response
{
"id": "foo"
"module": "Users",
"freebusy": [
{
"start": "2014-08-24T08:45:00-04:00",
"end": "2014-08-24T09:15:00-04:00"
},
{
"start": "2014-08-30T05:45:00-04:00",
"end": "2014-08-30T06:15:00-04:00"
},
{
"start": "2014-09-12T15:45:00-04:00",
"end": "2014-09-12T16:15:00-04:00"
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Leadsrecordfreebusy_GET/index.html |
5372575bd2c7-0 | /collection/:collection_name GET
Overview
Lists records from multiple modules at a time.
Summary
This endpoint will return a set of records fetched from multiple modules defined by :collection_name.
The records will be filtered, sorted and truncated to max_num as a single collection.
Collections may use a field mapping. For instance, the due_date of Tasks may be referred to as date_end.
In this case the alias (date_end) should be used in filter and order_by expressions instead of real field name.
Note that response data still contains the original fields for the module.
Request Arguments
Name
Type
Description
Required
fields
String
See Filter API. If the collection definition uses aliases, then aliases should be used instead of real field names.
False
max_num
Integer
See Filter API.
False
filter
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
order_by
String
See Filter API. If collection definition uses aliases, then aliases should be used instead of real field names.
False
offset
Map
Individual offset for each module which the collection consists of.
-1 (or any negative value) denotes that the module should be skipped.
If module offset is not specified, it defaults to 0.
False
Response Arguments
Name
Type
Description
next_offset
Map
The next offset to retrieve records. -1 will be returned for the given module when there are no more records.
records
Array
The record result set.
Response
{
"next_offset": {
"Calls": 1,
"Meetings": -1,
"Tasks": -2,
},
"records": [
{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/collectioncollection_name_GET/index.html |
5372575bd2c7-1 | "Tasks": -2,
},
"records": [
{
"_module": "Calls",
"id": "8703fbf3-0ffa-c288-8d2c-512f943ecdc3",
"name": "Discuss review process",
"date_end": "2014-02-26T19:12:00+00:00"
},
{
"_module": "Tasks",
"id": "e1c495cb-af17-1b37-dd66-512f934fe155",
"name": "Introduce all players",
"due_date": "2014-02-26T19:12:00+00:00"
},
{
"_module": "Tasks",
"id": "456b7848-9959-5a64-cd34-512d0938addd",
"name": "Follow-up on proposal",
"due_date": "2014-02-26T19:12:00+00:00"
}
]
}
Change Log
Version
Change
v10
Added /collection/:collection_name 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/collectioncollection_name_GET/index.html |
a5563950a776-0 | /Forecasts/:timeperiod_id/quotas/direct/: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
}
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_idquotasdirectuser_id_GET/index.html |
6dd54de9eddc-0 | /<module>/temp/file/:field/:temp_id GET
Overview
Reads a temporary image and deletes it.
Request Arguments
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
<image file>
String;
Returns the image content with the content headers.
Response
result: HTTP/1.1 200 OK
Date: Fri, 01 Mar 2013 05:36:24 GMT
Server: Apache/2.2.22 (Unix) DAV/2 PHP/5.3.17
X-Powered-By: PHP/5.3.17
Expires: Sun, 31 Mar 2013 05:36:24 GMT
Cache-Control: max-age=1, post-check=0, pre-check=0
Pragma: public
X-Content-Type-Options: nosniff
Content-Length: 2072
ETag: d41d8cd98f00b204e9800998ecf8427e
Connection: close
Content-Type: image/png
â°PNG | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-1 | Connection: close
Content-Type: image/png
â°PNG
IHDRIIqsÃÃIDATxÅÃÅ}hUçÃ?¿âºÃ«iÃlâ¹Ã¹Ãë⤩â¢Å¡S'âDâÃÃ4+ËÃv¸Â±ÂMö['vl°¹wêÃÂâmÅMÅ Ãâ¦jBWDD$ÃâËdR²L$ËË/!^sï9çùÃÂç^st7ÃcrÃÞ\î%ÃÅû¾çy¹y~ÂËËËËêA*Ãâ¬Âx"÷r!°pâ¬p
H¬ÿwEÃâ£b'BrjÂ6`°h®ÿŽçÂi¨Å¬²J
â°IMX)ŸÃ>? | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-2 | â°IMX)ŸÃ>?
$Co÷ à ß}ž"WXY$ÃwKµcSà ¬Ã&éA¤â¬Ãdæ«l·bI%eÃ¥$â¬Ã¥ÃF X4fþ°Ã
pâºÂ®"Ã%Ã"RVÃ%â¦RS¬ÃŠéZâ°âš¨L£Ã¤ë0Ã
OWÃ$â¦RÃlÃÃYâ¡Â±æ'š¨à *p+ë`Å"¦k^'B©ù(v¬éºÂâ¢75Qâ¢Ãæ«âºÂ®IË_ºæ$)+'â°MM'ø">5Q1ÃuÃà ïÃ6]þ\dEâJM=v¬é¶`Sã6]CÃQ`¸ ÃÃõ@I¡Ã´`¥äRÃ@u¤&*»HÃŽ]ÆDLWAI#·$ùº | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-3 | ÃXý¾÷+`ÃâÂWÃ/ÃúæâIX PµŸX®JRâ¹ÃÃà êÃOâ{IÃ|û¬Irà ÅW®M5|Ãh§'ôXÂJ#BB] ðÂ5¨ÃÃ
¨ï÷éÃâé¡Ã_âÅŸÃúOåýü}tð)Êòt ü'â¬Ã÷ÃãÃSâ¢Ã¥iè | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-4 | '6EkAªVâª"vscŽúìÃq}vg3¾ÃE4 AdÃ+ªÂ¤ÃÃâ¬Âµj½ UNgãµÃâ¢7n'âu=è5ÃzÃnP«"]¶>ªÃi'¬Ã@&ÃÆê:±âºl°Kâ¦/£ù$âÂe'õâ¹Ã¨Å½G"ë0ºwIÃqý»ngöö¦ÃMµé'vUæLâ¢KË¢šÃË~s\¿üÃâîøB+~ð5 ¼n¯UTäžâ5a'Â¥Ã|Ã.$Ãd!jÂÃIhWÃsdáâS¯-\p"©~éfêµOÃõâ¦ÃY4iö3J,ÃÃK 'ñü~mþäËyù¥âÃÃlÃKÿP2⢠| https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-5 | ¨.âºÃ©Ãÿµ&O_gËÃtžxTDv8ªÃ.~¯aÃqúzîd¾ûÃTºÃÆÃ@ìV¤înçñ¡9lrt
!ú@þsâ¢ÃnlÃóöJà ux+Ã
ÃdùÃD¦(kqâ¬Â¶Â¬r"=µÃéþZ§/©úÃ/nÂ¥7ùÃ
Þ@d°|^éRõÂ1Q=EôëÃæasà 7u'LlÃÃôÂN¯´Ã.oæ!'GQâ âeÃÃnâ±}â¹ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-6 | zðÃgÃþoMN7ÃÃÃÃâ¢Â±>§jîäfÃâºÃyâà Ë&jâ ôÃ/^ç©5mxÃób¼-dh¾âº(Å Å%[=gÃÃ*Jâ¹Æ>sÃIžÃµô#}5ª?¿â¢zýqôûHo lÅ¡'án©â}Â1žÆïÃÃ'Ãâ¢Â¿jas65.ª | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-7 | 2ó¡%éK÷*$Y*ÃènA{añ¢Ãô¯Nû?z~òN½ÃV]F¤I²-tÅ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-8 | 8¡ÃäÃúÃý7ùTkâ¢Ã´>ñÃ[¢jÃ^"1aJ.)Ãâ¦Â»Ã©ââGT¿xé9»{iÃâ°Â¤2øÃ[©?7ùf¡/R+ž?Ã"-SæÃ?k"'èÃּHO¯ÃúÃÃ
JÃô»Td³ªÂ'zÂNìðÂ/ÃCäÃWvî4]Ã]IRwöøÃ_âºÃ¯Â¶Â³ÅbÃTä«Ž{»*IiIÃþc6Â¥oÃ@n§¶Ë1?ÃD'ËTLTÃ÷AMªºÃqÅ:`"Ââ¢Â¦Å¡$¬â`vâ¹P5Tâ¢$µÂªjTaƪ'XRbIË%E âÂXRbIË%E âÂXRbIË%E âÂXRbIË%E | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-9 | âÂXRbIË%E âÂXRbI($éÃ&pÃþáSà ÃßlM]> | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-10 | IÃ
žsþ0ð¶T,/â¦$]bâ¹[>Ã\^¡@?óJ~7÷òoÃXÃâ¢"7®ÃLctöoBþ"·P IYQ>ðGlÃÃìÃ
®µ©å%WTø&ðMlçŸ6Aðâ¬S%YQÃu;.ÂÃÃúuc«"*Q²õ°LcÃÿ¶jiâlâ°W!99"½ Ã~"®Ãq[Ãy[2Ãâ¹-Ãâ¢kÃh©â¢öaKQ/&Å Ë0}>)wºnÃvöû+÷·`'+Ã
vfÃŽÂ-j~X99æ|Ë+"®)ÃÃ8Â=Uÿ;f
'7bÃâ#]['ûÃãç*&LQNºâ¦Ã®KÃ!ì¬ÃŽÂùÃ)ÃÃz¹"KÃöâºÃ
Change Log
Version
Change
v10 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
6dd54de9eddc-11 | Change Log
Version
Change
v10
Added /<module>/enum/:field GET endpoint.
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/moduletempfilefieldtemp_id_GET/index.html |
a255764de8c9-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 |
c507c1b6cad5-0 | /Forecasts/:timeperiod_id/:user_id/chart/:display_manager GET
Retrieve a Forecasting Information In SugarChart Format
Summary:
This endpoint is used to return the json Data for SugarCharts to use to display the needed chart.
Query Parameters:
Param
Description
Optional
timeperiod_id
Show for a specific time period
Â
user_id
Show for a specific user
Â
display_manager
Pipeline or Committed are valid values.
Â
dataset
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specified
Optional
group_by
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales Stage
Optional
ranges
Pipeline or Committed are valid values.
Optional
Input Example:
{
'user_id':'seed_max_id,
'timeperiod_id':'36f7085a-5889-ea75-84c8-50f42bd1a5ba',
'display_manager':'false',
'group_by': 'forecast',
'dataset': 'likely',
'ranges': 'include',
}
Output Example:
{ "color" : [ "#8c2b2b",
"#468c2b",
"#2b5d8c",
"#cd5200",
"#e6bf00",
"#7f3acd",
"#00a9b8",
"#572323",
"#004d00",
"#000087",
"#e48d30",
"#9fba09",
"#560066",
"#009f92",
"#b36262",
"#38795c",
"#3D3D99", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html |
c507c1b6cad5-1 | "#38795c",
"#3D3D99",
"#99623d",
"#998a3d",
"#994e78",
"#3d6899",
"#CC0000",
"#00CC00",
"#0000CC",
"#cc5200",
"#ccaa00",
"#6600cc",
"#005fcc"
],
"label" : [ "Include" ],
"properties" : [ { "gauge_target_list" : "Array",
"goal_marker_color" : [ "#000000",
"#7D12B2"
],
"goal_marker_label" : [ "Quota",
"Likely Case"
],
"goal_marker_type" : [ "group",
"pareto"
],
"label_name" : "Include in Forecast",
"labels" : "value",
"legend" : "on",
"print" : "on",
"subtitle" : "",
"thousands" : "",
"title" : null,
"type" : "bar chart",
"value_name" : "Likely Case"
} ],
"values" : [ { "goalmarkervalue" : [ "111000.00",
"36000.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$36,000.00"
],
"gvalue" : 36000,
"gvaluelabel" : "$36,000.00",
"label" : "January 2013",
"links" : [ "" ], | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html |
c507c1b6cad5-2 | "links" : [ "" ],
"valuelabels" : [ "$36,000.00" ],
"values" : [ 36000 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 25500,
"gvaluelabel" : "$25,500.00",
"label" : "February 2013",
"links" : [ "" ],
"valuelabels" : [ "$25,500.00" ],
"values" : [ 25500 ]
},
{ "goalmarkervalue" : [ "111000.00",
"61500.00"
],
"goalmarkervaluelabel" : [ "$111,000.00",
"$61,500.00"
],
"gvalue" : 0,
"gvaluelabel" : "$0.00",
"label" : "March 2013",
"links" : [ "" ],
"valuelabels" : [ "$0.00" ],
"values" : [ 0 ]
}
]
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Forecaststimeperiod_iduser_idchartdisplay_manager_GET/index.html |
b693b1ae5974-0 | /me/preference/:preference_name GET
Overview
Returns a specific preference for the current user.
Request Arguments
This endpoint does not accept any request arguments.
Response Arguments
Name
Type
Description
Â
Â
Â
Response
{
}
Change Log
Version
Change
v10
Added /me/preference/:preference_name 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/mepreferencepreference_name_GET/index.html |
f115723328f2-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
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
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 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinkhistory_GET/index.html |
f115723328f2-1 | }
}
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 |
873c8179d216-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
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",
"best_case_adjusted":"37310.000000",
"likely_case":"28694.444445",
"likely_case_adjusted":"35868.055556",
"worst_case":"27540.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 |
873c8179d216-1 | "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",
"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"
},
{
"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", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/ForecastManagerWorksheetstimeperiod_iduser_id_GET/index.html |
873c8179d216-2 | "likely_case":"14928.222222",
"likely_case_adjusted":"12440.185185",
"worst_case":"14008.222223",
"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":[
{
"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",
"best_case_adjusted":"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 |
873c8179d216-3 | "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",
"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 |
2af2ffe736b6-0 | /pmse_Project/ActivityDefinition/:record PUT
Overview
Updates the definition data for an activity
Summary
This endpoint will update the Process Definition activity identified by the
record input parameter with the data provided in the request
payload.
Request Arguments
Name
Type
Description
Required
record
String
The value for the act_uid field in the pmse_bpmn_activity record
True
Request Payload
{
"data":
{
"act_field_module":"Accounts",
"act_fields":"[{\"name\":\"Assigned to\",\"field\":\"assigned_user_id\",\"value\":\"owner\",\"type\":\"user\",\"label\":\"Record owner\"}]"
}
}
Response Arguments
Name
Type
Description
success
Boolean
The status of the update operation
Response
{
"success":true
}
Last modified: 2023-02-03 21:04:03 | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/pmse_ProjectActivityDefinitionrecord_PUT/index.html |
0516e35bd89a-0 | /<module>/:record/link/:link_name/:remote_id POST
Overview
Creates a relationship to a pre-existing record.
Query String Parameters
This endpoint does not accept any arguments.
Response Arguments
Name
Type
Description
record
Array
The record linked to the related record.
related_record
Array
The record that was 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":"",
"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_nameremote_id_POST/index.html |
0516e35bd89a-1 | "opportunity_type":"",
"account_name":"Slender Broadband Inc",
"account_id":"181461c6-dc81-1115-1fe0-512d092e8f15",
"campaign_id":"",
"campaign_name":"",
"lead_source":"Campaign",
"amount":"25000",
"base_rate":"1",
"amount_usdollar":"25000",
"currency_id":"-99",
"currency_name":"",
"currency_symbol":"",
"date_closed":"2013-02-27",
"date_closed_timestamp":"1361992480",
"next_step":"",
"sales_stage":"Needs Analysis",
"sales_status":"New",
"probability":"90",
"best_case":"25000",
"worst_case":"25000",
"commit_stage":"include",
"my_favorite":false,
"_acl":{
"fields":{
}
}
},
"related_record":{
"id":"e689173e-c953-1e14-c215-512d0927e7a2",
"name":"Gus Dales",
"date_entered":"2013-02-26T19:12:00+00:00",
"date_modified":"2013-02-26T19:12:00+00:00",
"modified_user_id":"1",
"modified_by_name":"Administrator",
"created_by":"1",
"created_by_name":"Administrator",
"description":"",
"img":"",
"deleted":false,
"assigned_user_id":"seed_sally_id", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html |
0516e35bd89a-2 | "deleted":false,
"assigned_user_id":"seed_sally_id",
"assigned_user_name":"Sally Bronsen",
"team_name":[
{
"id":"West",
"name":"West",
"name_2":"",
"primary":true
}
],
"salutation":"",
"first_name":"Gus",
"last_name":"Dales",
"full_name":"Gus Dales",
"title":"Director Operations",
"linkedin":"",
"facebook":"",
"twitter":"",
"googleplus":"",
"department":"",
"do_not_call":false,
"phone_home":"(661) 120-2292",
"email":[
{
"email_address":"[email protected]",
"opt_out":"1",
"invalid_email":"0",
"primary_address":"0"
},
{
"email_address":"[email protected]",
"opt_out":"0",
"invalid_email":"0",
"primary_address":"1"
}
],
"phone_mobile":"(294) 447-9707",
"phone_work":"(036) 840-3216",
"phone_other":"",
"phone_fax":"",
"email1":"[email protected]",
"email2":"[email protected]",
"invalid_email":false,
"email_opt_out":false,
"primary_address_street":"48920 San Carlos Ave",
"primary_address_street_2":"",
"primary_address_street_3":"", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html |
0516e35bd89a-3 | "primary_address_street_2":"",
"primary_address_street_3":"",
"primary_address_city":"Persistance",
"primary_address_state":"CA",
"primary_address_postalcode":"54556",
"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":"Arts & Crafts Inc",
"account_id":"d43243c6-9b8e-2973-aee2-512d09bc34b4",
"opportunity_role_fields":"",
"opportunity_role_id":"",
"opportunity_role":"Technical Advisor",
"reports_to_id":"",
"report_to_name":"",
"portal_name":"GusDales145",
"portal_active":true,
"portal_password":"$1$JxYr6tmM$b.O6.KF42jP46RadSwz0N0",
"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":{ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/modulerecordlinklink_nameremote_id_POST/index.html |
0516e35bd89a-4 | "my_favorite":false,
"_acl":{
"fields":{
}
}
}
}
Change Log
Version
Change
v10
Added /<module>/:record/link/:link_name/: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_nameremote_id_POST/index.html |
33ff8b1641fa-0 | /Emails/:record/link/:link_name/:remote_id DELETE
Overview
Deletes an existing relationship between an email and another record.
Summary
The sender (link: from) cannot be removed. Replace the sender with a different sender instead. All other
operations described in Relate Record API are
supported.
Change Log
Version
Change
v10
Added /Emails/:record/link/:link_name/:remote_id 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/Emailsrecordlinklink_nameremote_id_DELETE/index.html |
0135897b6d16-0 | /oauth2/bwc/login POST
ATTENTION: FOR INTERNAL USAGE ONLY
This endpoint is subject to change.
Overview
Retrieves a cookie from the OAuth token.
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/oauth2bwclogin_POST/index.html |
050278528951-0 | /Emails/filter GET
Overview
Lists filtered emails.
Summary
Adds additional operators to Filter API that are
specific to Emails. A special macro, $current_user_id, is a convenience that allows for finding emails
involving the current user.
Filter By Sender
This will return all emails sent by the current user, by the contact whose ID is
fa300a0e-0ad1-b322-9601-512d0983c19a, using the email address [email protected], which is referenced by
the ID b0701501-1fab-8ae7-3942-540da93f5017, or by the lead whose ID is
73b1087e-4bb6-11e7-acaa-3c15c2d582c6 using the email address [email protected], which is referenced by
the ID b651d834-4bb6-11e7-bfcf-3c15c2d582c6.
{
"filter": [{
"$from": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
050278528951-1 | "email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}, {
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}, {
"email_address_id": "b0701501-1fab-8ae7-3942-540da93f5017"
}, {
"parent_type": "Leads",
"parent_id": "73b1087e-4bb6-11e7-acaa-3c15c2d582c6",
"email_address_id": "b651d834-4bb6-11e7-bfcf-3c15c2d582c6"
}]
}
}]
}
Filter By Recipients
This would return all archived emails received by the current user.
{
"filter": [{
"$or": [{
"$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}]
}, {
"state": {
"$in": [ | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
050278528951-2 | }]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Filter By Sender and Recipients
This would return all archived emails sent by a contact to the current user.
{
"filter": [{
"$from": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}, {
"$or": [{
"$to": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$cc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}],
"$bcc": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}]
}, {
"state": { | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Emailsfilter_GET/index.html |
050278528951-3 | }]
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Equivalent to:
{
"filter": [{
"from_collection": {
"$in": [{
"parent_type": "Contacts",
"parent_id": "fa300a0e-0ad1-b322-9601-512d0983c19a"
}]
}
}, {
"$or": [{
"to_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"cc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
},
"bcc_collection": {
"$in": [{
"parent_type": "Users",
"parent_id": "$current_user_id"
}]
}
}]
}, {
"state": {
"$in": [
"Archived"
]
}
}]
}
Change Log
Version
Change
v10
Added the $from, $to, $cc, and $bcc operators to
/Emails/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/Emailsfilter_GET/index.html |
41a7488b9eac-0 | /Mail/attachment POST
Overview
Upload an email attachment
Query String Parameters
This endpoint does not accept any query string parameters.
Input Parameters
Name
Type
Description
Required
email_attachment
String
The file to upload.
True
Input Example
{"email_attachment":"@\/path\/to\/ExampleDocument.txt"}
Result
Name
Type
Description
<email record field>
<email record field type>
Returns the fields for the newly created email record.
Output Example
{
"guid": "61b19f41-0ac9-0f2f-d9c5-51eecaf89396",
"name": "ExampleDocument.txt",
"nameForDisplay": "ExampleDocument.txt"
}
Change Log
Version
Change
v11
Last version in which /Mail/attachment POST is available. Use
/Notes/temp/file/filename POST in conjunction with
/Emails/:record/link/attachments POST instead.
v10
Added /Mail/attachment 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/Mailattachment_POST/index.html |
5fe86de4cfd3-0 | /Calendar/invitee_search GET
Overview
Temporary API - Do Not Use! This endpoint will be removed in an upcoming release. Use /search endpoint instead.
Searches for people to invite to an event (meeting or call).
Request Arguments
Name
Type
Description
Required
q
String
The search text to match records on.
True
module_list
String
Comma delimited list of modules to search.
True
search_fields
String
Comma delimited list of fields to search.
True
fields
String
Comma delimited list of fields to return. Search fields will automatically be added to return list.
True
Response Arguments
Name
Type
Description
next_offset
Integer
Currently only returns -1 as paging is not supported yet.
records
Array
An array of results containing matched records.
Response
{
"next_offset": -1,
"records": [
{
"id": "17283aad-8d15-c545-fc5a-5422fe3d8ef8",
"date_modified": "2014-09-24T13:25:28-04:00",
"email": [
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": true,
"primary_address": false,
"reply_to_address": false
},
{
"email_address": "[email protected]",
"invalid_email": false, | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calendarinvitee_search_GET/index.html |
5fe86de4cfd3-1 | "invalid_email": false,
"opt_out": false,
"primary_address": true,
"reply_to_address": true
}
],
"full_name": "Renaldo Cuffee",
"account_name": "EEE Endowments LTD",
"_acl": {
"fields": {}
},
"_module": "Contacts",
"_search": {
"highlighted": {
"account_name": {
"text": "EEE Endowments LTD",
"module": "Contacts",
"label": "LBL_ACCOUNT_NAME"
}
}
}
},
{
"id": "19c0fa4a-a6c0-940f-7ad6-5422fe62a00a",
"date_modified": "2014-09-24T13:25:28-04:00",
"email": [
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": true,
"primary_address": false,
"reply_to_address": false
},
{
"email_address": "[email protected]",
"invalid_email": false,
"opt_out": false,
"primary_address": true,
"reply_to_address": true
}
],
"full_name": "Noble Canto",
"account_name": "EEE Endowments LTD",
"_acl": {
"fields": {}
},
"_module": "Contacts",
"_search": {
"highlighted": {
"account_name": {
"text": "EEE Endowments LTD", | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/Calendarinvitee_search_GET/index.html |
5fe86de4cfd3-2 | "account_name": {
"text": "EEE Endowments LTD",
"module": "Contacts",
"label": "LBL_ACCOUNT_NAME"
}
}
}
}
]
}
Change Log
Version
Change
v10
Added /<module>/send_invites 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/Calendarinvitee_search_GET/index.html |
50a0c05d0215-0 | /pmse_Inbox/historyLog/:filter GET
Overview
Gets the history log for a process
Summary
This endpoint gets the history log for a process
Request Arguments
Name
Type
Description
Required
filter
string
The id of the process trigger sequence (cas_id)
true
Response Arguments
Name
Type
Description
success
boolean
Result of the operation
result
<field>:<value>
History records
Response
{
"success":true,
"result":
[
{
"image":"index.php?entryPoint=download\u0026id=0b2dc2f0-2377-11e6-9d2a-6c4008960436\u0026type=SugarFieldImage\u0026isTempFile=1",
"user":"Administrator",
"current_user":"Administrator",
"due_date":"2016-06-03T16:18:59-07:00",
"end_date":"2016-06-01T16:18:59-07:00",
"current_date":"2016-06-02T10:53:14-07:00",
"delegate_date":"2016-06-01T16:18:59-07:00",
"start_date":"2016-06-01T16:18:59-07:00",
"completed":true,
"cas_user_id":"1",
"data_info":"has created Process #2 on the Account record with the event \u0027Start Event # 1\u0027."
},
]
}
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_InboxhistoryLogfilter_GET/index.html |
5152a9305b3e-0 | /oauth2/token POST
Overview
Retrieves the token portion of the OAuth 2.0 specification.
Request Arguments
Name
Type
Description
Required
grant_type
String
Type of request. Available grant types are "password" and "refresh_token".
True
client_id
String
Used to identify the client. A client_id of "sugar" will automatically create an OAuth Key in the system that is used for "password" authentication. A client_id of "support_portal" will create an OAuth Key that will allow for portal authentication. Additional client_id's can be created by the administrator in Admin > OAuth Keys to allow for additional grant types. If the client secret is populated, it will be validated against the client id.
True
client_secret;
String
The clients secret key.
True
username
String
The username of the user authenticating to the system.
True
password
String
The plaintext password the user authenticating to the system.
True
platform
String
The platform type. Available types are "base", "mobile", and "portal".
True
Request for Password Grant Types
{
"grant_type":"password",
"client_id":"sugar",
"client_secret":"",
"username":"admin",
"password":"password",
"platform":"base"
}
Request for Refresh Token Grant Types
{
"grant_type":"refresh_token",
"refresh_token":"c1be5132-655b-1ca3-fb44-512e36709871",
"client_id":"sugar",
"client_secret":"",
"platform":"base"
}
Response Arguments
Name
Type
Description
access_token
String
The access token needed to authenticate for other methods.
expires_in
Integer
The length of time until access_token expires in seconds.
token_type | https://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_13.0/Integration/Web_Services/REST_API/Endpoints/oauth2token_POST/index.html |
5152a9305b3e-1 | expires_in
Integer
The length of time until access_token expires in seconds.
token_type
String
The token type. Currently only "bearer" is supported.
null|
Â
The Oauth scope. Normally returned as null.
refresh_token
String
The token needed to extend the access_token expiration timeout.
refresh_expires_in
Integer
The length of time until refresh_token expires in seconds.
download_token
String
The token used to download images and files.
Response
{
"access_token":"802b64c0-5eac-8431-a541-5342d38ac527",
"expires_in":3600,
"token_type":"bearer",
"scope":null,
"refresh_token":"85053198-24b1-4521-b1a1-5342d382e0b7",
"refresh_expires_in":1209600,
"download_token":"8c9b5461-0d95-8d87-6084-5342d357b39e"
}
Change Log
Version
Change
v10
Added /oauth2/token 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/oauth2token_POST/index.html |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.