ARCHIVE – SugarCRM REST API v10 – Connecting to 6.7.0 on Demand

The information below may be outdated

Contact us if you have any queries

With the Release of SugarCRM 6.7.0 a new API has been exposed – REST version 10.

This is the first step in the massive leap forward from SugarCRM 6 to 7.

The new REST API is super fast, and from a developers perspective, very well documented. SugarCRM have implemented WSDL like online help.

Here is a screenshot of a GET REST API call to SugarCRM 6.7.0 using the new v10 interface:

 

 

 

 

 

If you are looking for support to develop new integrations with SugarCRM, make sure to use this new API.

Provident CRM are a SugarCRM Gold Partner and provide Support, Hosting and Development Services for customers requiring Business Solutions in the UK and Ireland.

contact us:     ph: +353 1 693 0000    email: sales@providentcrm.com

 

Below is full list of the API calls supported in SugarCRM 6.7.0 REST v10

SugarCRM API

GET

/<module>
Search records in this module
6.25

List Records In Module

 

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

 

Query Parameters:

 

 

+
Param

DescriptionOptional
qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional
maxResultA maximum number of records to returnOptional
offsetHow many records to skip over before records are returnedOptional
fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional
order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional
favoritesOnly fetch favorite recordsOptional
deletedShow deleted records in addition to undeleted recordsOptional

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

 


File:clients/base/api/UnifiedSearchApi.php
Method:globalSearch

+

POST

/<module>

This method creates a new record of the specified type

6.25

 

 

 

Create a new record of a specified type.

 

 

Summary:

This endpoint creates a single record.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

{ "name":"Call Test", "date_start":"2012-09-11T13:34:23-07:00", "duration_minutes":"30", "status":"Planned", "direction":"Inbound", ... additional fields ... }

Output Example:

{ "id": "5526df55-d3b5-ccd6-59b1-5058a5b5492c", "name": "Call Test", "date_entered": "2012-09-18T09:46:00-0700", "date_modified": "2012-09-18T09:46:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "", "assigned_user_name": "", "team_name": [ { "id": 1, "name": "Global", "name_2": "", "primary": true } ], "duration_hours": 0, "duration_minutes": "30", "date_start": "2012-09-11T13:34:00-0700", "parent_type": "", "parent_name": "", "status": "Planned", "direction": "Inbound", "parent_id": "", "reminder_checked": false, ... additional fields ... }

 


File:clients/base/api/ModuleApi.php
Method:createRecord

+

DELETE

/<module>/:record

This method deletes a record of the specified type

7.00

 

 

 

Delete a record of a specified type.

 

 

Summary:

This endpoint sets a records field to deleted=1, so it is no longer visible. The record is still in the database.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "id": "11cf0d0a-40af-8cb1-9da0-5057a5f511f9" }

 


File:clients/base/api/ModuleApi.php
Method:deleteRecord

+

GET

/<module>/:record

Returns a single record

7.00

 

 

 

Retrieve records of a specified type.

 

 

Summary:

This endpoint returns record(s) within a module.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "id": "f384c2b4-6edf-723d-db4e-5057a54a669f", "name": "Randy Woodward", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

 


File:clients/base/api/ModuleApi.php
Method:retrieveRecord

+

PUT

/<module>/:record

This method updates a record of the specified type

7.00

 

 

 

Update a record of the specified type.

 

 

Summary:

This endpoint updates a single record.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

{ "name":"New Acct Name", "phone_office":"(555) 888-5555", "website":"www.newsite.com", ... additional fields ... }

Output Example:

{ "id": "21130cb0-df8a-4376-a9b3-5057a5f86104", "name": "New Account Name", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-18T10:11:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_sally_id", "assigned_user_name": "Sally Bronsen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

 


File:clients/base/api/ModuleApi.php
Method:updateRecord

+

DELETE

/<module>/:record/favorite

This method unsets a record of the specified type as a favorite

8.75

 

 

 

Unfavorite a record of a specified type.

 

 

Summary:

This endpoint unsets a records as a favorite for the logged in user.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "id": "f384c2b4-6edf-723d-db4e-5057a54a669f", "name": "Randy Woodward", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

 


File:clients/base/api/ModuleApi.php
Method:unsetFavorite

+

PUT

/<module>/:record/favorite

This method sets a record of the specified type as a favorite

8.75

 

 

 

Favorite a record of a specified type.

 

 

Summary:

This endpoint sets a records as a favorite for the logged in user.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "id": "f384c2b4-6edf-723d-db4e-5057a54a669f", "name": "Randy Woodward", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

 


File:clients/base/api/ModuleApi.php
Method:setFavorite

+

GET

/<module>/:record/file

Gets a listing of files related to a field for a module record.

8.75

 

 

 

Lists attachment fields for a record

 

 

Summary:

This endpoint lists all fields of type “file” or of type “image” for a record that contain an attachment.

 

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.

 

Input Example:

This endpoint does not accept any input.

 

 

Output Example:

{ picture: { content-type: "image/jpeg", content-length: 47249, name: "a9726941-af60-d47c-86cb-4fcebb1a24cf", uri: "http://your.sugarcrm.install/rest/v10/Contacts/10500b19-24ab-c7dd-7757-4fc8f9a63f10/file/picture" } }

 


File:clients/base/api/FileApi.php
Method:getFileList

+

GET

/<module>/:record/file/:field

Gets the contents of a single file related to a field for a module record.

9.50

 

 

 

Gets a file attached to a field in a record

 

 

Summary:

This endpoint retrieves an attached file for a field in a record. The response from this request is an HTTP response with a forced download. This can be used in rendering images through the API or in offering immediate file downloads.

 

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.

 

Input Example:

This endpoint does not accept any input.

 

 

Output Example:

Cache-Control: no-cache, must-revalidate Connection: keep-alive Content-Encoding: gzip Content-Type: application/octet-stream Date: Mon, 30 Jan 2012 17:00:46 GMT Expires: Mon, 30 Jan 2012 17:00:45 GMT Last-Modified: Thu, 10 Nov 2011 19:01:31 GMT Transfer-Encoding: chunked Vary: Accept-Encoding . . . .

 


File:clients/base/api/FileApi.php
Method:getFile

+

POST

/<module>/:record/file/:field

Saves a file. The file can be a new file or a file override.

9.50

 

 

 

Attaches a file to a field in a record

 

 

Summary:

This endpoint takes a file or image and saves it to a record.

 

 

Query Parameters:

 

Param Description Optional
format sugar-html-json Required delete_if_fails Boolean indicating whether the API is to mark related record deleted if the file upload fails. Optional (if used oauth_token is also required) oauth_token oauth_token_value Optional (Required if delete_if_fails is true)

 

Input Example:

POST /rest/v10/Notes/abcd-1234/file/filename?format=sugar-html-json&delete_if_fails=true&oauth_token= HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 10263 Cache-Control: max-age=0 Content-Type: multipart/form-data; boundary=---WebKitFormBoundarybThnfMCVqnkSxLCl Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 Accept-Encoding: gzip Accept-Language: en-US,en;q=0.8 ------WebKitFormBoundarybThnfMCVqnkSxLCl Content-Disposition: form-data; name="file"; filename="my-awesome-document.xyz" Content-Type: application/document-xyz ...This is where the bin data would be

 

Output Example:

{ "field": { "content-type": "application/document-xyz", "content-length": "657483", "name": "my-awesome-document.xyz", "uri": "http://your.sugarcrm.install/rest/v10//Notes/abc-1234/file/field" } }

 


File:clients/base/api/FileApi.php
Method:saveFilePost

+

DELETE

/<module>/:record/file/:field

Removes a file from a field.

9.50

 

 

 

Removes an attachment from a field for a record

 

 

Summary:

This endpoint removes an attachment from a field for a record and subsequently removes the file from the file system. Returns the same list as GET /<module>/?/file does.

 

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.

 

Input Example:

This endpoint does not accept any input.

 

 

Output Example:

{ picture: {} }

 


File:clients/base/api/FileApi.php
Method:removeFile

+

PUT

/<module>/:record/file/:field

Saves a file. The file can be a new file or a file override. (This is an alias of the POST method save.)

9.50

 

 

 

Attaches a file to a field in a record that currently contains an existing attachment

 

 

Summary:

This endpoint takes a file or image and saves it to a record that already contains an attachment in the specificed field.

NOTE: The PUT method is very similar to the POST method but differs slightly in how the request is constructed. PUT requests should send the file data as the body of the request. Optionally, a filename query param can be sent with the request.

 

 

Query Parameters:

 

Param Description Optional
filename Filename to save the document as Optional

 

Input Example:

PUT /rest/v10/Notes/abcd-1234/file/field/ HTTP/1.1 Host: localhost Connection: keep-alive Content-Length: 23456 Content-Type: application/document-doc ...This is where the bin data would be

 

Output Example:

{ "field": { "content-type": "application/document-doc", "content-length": "657483", "name": "yourfilename.doc", "uri": "http://your.sugarcrm.install/rest/v10//Notes/abc-1234/file/field" } }

 


File:clients/base/api/FileApi.php
Method:saveFilePut

+

POST

/<module>/:record/link/:link_name

Create a single record and relate it to this module

9.50

 

 

 

Create a single related record with relationship role information

 

 

Summary:

This endpoint creates a single related record including any additional information that is in the relationship record. For example, the Opportunities – Contacts relationship has a role that is placed on the contact, when creating a contact record normally you will not be able to set this role but if you create it through this endpoint you will be able to set the role in addition to the rest of the record.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

{ "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }

 

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

 


File:clients/base/api/RelateRecordApi.php
Method:createRelatedRecord

+

GET

/<module>/:record/link/:link_name

List related records to this module

9.50

 

 

 

List related records to this module.

 

 

Summary:

This endpoint lists records related to a module.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "next_offset": -1, "records": [ { "id": "1ddc9209-444f-56c0-3d8f-5057a50878e3", "name": "Sea Region Inc - 1000 units", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "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": "Sea Region Inc", "account_id": "1101ca6f-6bf0-8a90-5750-5057a5a61d6d", "campaign_id": "", "campaign_name": "", "lead_source": "Support Portal User Registration", "amount": "50000", "amount_usdollar": "50000", "currency_id": "-99", "currency_name": "", "currency_symbol": "", "date_closed": "2013-07-05", "next_step": "", "sales_stage": "Value Proposition", "probability": "70", "my_favorite": false }, ... additional fields ...

 


File:clients/base/api/RelateApi.php
Method:listRelated

+

POST

/<module>/:record/link/:link_name/:remote_id

Relates an existing record to this module

10.25

 

 

 

Create a relationship to an existing record

 

 

Summary:

This endpoint is used to create a relationship to a pre-existing record. The input can be left blank if there is no additional relationship information to fill in.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

{ "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. } This information is only necessary on records where there is additional relationship information.

 

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

 


File:clients/base/api/RelateRecordApi.php
Method:createRelatedLink

+

GET

/<module>/:record/link/:link_name/:remote_id

Fetch a single record related to this module

10.25

 

 

 

Get a single related record with relationship role information

 

 

Summary:

This endpoint retrieves a single related record including any additional information that is in the relationship record. For example, the Opportunities – Contacts relationship has a role that is placed on the contact, when fetching a contact record normally you will not get this role but if you fetch it through this relationship you will get the role in addition to the rest of the record.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Primary Decision Maker", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }

 


File:clients/base/api/RelateRecordApi.php
Method:getRelatedRecord

+

PUT

/<module>/:record/link/:link_name/:remote_id

Updates relationship specific information

10.25

 

 

 

Update relationship specific information on an existing relationship

 

 

Summary:

This endpoint is used to update relationship specific information in an existing relationship. This endpoint is only usful on relationships with additional relationship specific information in them such as the Contact to Opportunity relationship.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

{ "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. }

 

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

 


File:clients/base/api/RelateRecordApi.php
Method:updateRelatedLink

+

DELETE

/<module>/:record/link/:link_name/:remote_id

Deletes a relationship between two records

10.25

 

 

 

Deletes a relationship between two records

 

 

Summary:

This endpoint is used to delete relationships, this endpoint will only delete the relationship between the two records and will not touch either record.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

This endpoint does not accept any input.

 

Output Example:

{ "record": { "id":"3141568b-4e5b-63f1-1658-4f8c7675955c", "name":"Yellow boat", "amount": 28999.99, "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":"This person wants to buy a yellow boat.", "deleted":"0", This record is not deleted, only the relationship is removed. "assigned_user_id":"seed_sarah_id", ... additional fields ... }, "related_record": { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", This is the ID of the related record, not of the intermediate relationship. "contact_role":"Technical Advisor", This information is part of the relationship, and not in the actual related record. "first_name":"Bill", "last_name":"Edwards", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1", "description":null, "deleted":"0", This record is not deleted, only the relationship is removed. "assigned_user_id":"seed_sarah_id", ... additional fields ... } }

 


File:clients/base/api/RelateRecordApi.php
Method:deleteRelatedLink

+

PUT

/<module>/:record/unfavorite

This method unsets a record of the specified type as a favorite

8.75

 

 

 

Unfavorite a record of a specified type.

 

 

Summary:

This endpoint unsets a records as a favorite for the logged in user.

 

Query Parameters:

 

Param Description Optional
This endpoint does not accept any parameters.
Input Example:

 

Output Example:

{ "id": "f384c2b4-6edf-723d-db4e-5057a54a669f", "name": "Randy Woodward", "date_entered": "2012-09-17T15:33:00-0700", "date_modified": "2012-09-17T15:33:00-0700", "modified_user_id": "1", "modified_by_name": "Administrator", "created_by": "1", "created_by_name": "Administrator", "description": "", "deleted": "0", "assigned_user_id": "seed_max_id", "assigned_user_name": "Max Jensen", "team_name": [ { "id": "East", "name": "East", "name_2": "", "primary": false }, ... additional fields ...

 


File:clients/base/api/ModuleApi.php
Method:unsetFavorite

+

PUT

/<module>/config

Update forecasts config

8.00

 

 

Long help file not found: include/api/help/ConfigApi.html#configUpdate


File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:configSave

 

 

+

POST

/<module>/config

create forecasts config

8.00

 

 

Long help file not found: include/api/help/ConfigApi.html#configCreate


File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:configSave

 

 

+

GET

/<module>/config

forecasts config

8.00

 

 

Long help file not found: include/api/help/ConfigApi.html#config


File:modules/Forecasts/clients/base/api/ForecastsConfigApi.php
Method:config

 

 

+

GET

/<module>/enum/:field

This method returns enum values for a specified field

8.75

 

 

 

Retreive Enum Field Options for a given Module.

 

 

Summary:

This endpoint lists options for a given enum field.

 

Query Parameters:

 

Param Description Optional
Field This is the field you want options forNo
Input Example:

 

Output Example:

{ "key":"value" }

 


File:clients/base/api/ModuleApi.php
Method:getEnumValues

+

GET

/Employees

Search Employee records

7.00

 

 

 

List Records In Module

 

 

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

 


File:clients/base/api/PersonUnifiedSearchApi.php
Method:globalSearch

+

GET

/ForecastManagerWorksheets

Returns a collection of ForecastManagerWorksheet models

7.00

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetManagerApi.html#forecastWorksheetManager


File:modules/Forecasts/clients/base/api/ForecastsWorksheetManagerApi.php
Method:forecastManagerWorksheet

 

 

+

PUT

/ForecastManagerWorksheets/:record

Update a ForecastManagerWorksheet model

7.75

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetManagerApi.html#forecastWorksheetManagerSave


File:modules/Forecasts/clients/base/api/ForecastsWorksheetManagerApi.php
Method:forecastManagerWorksheetSave

 

 

+

GET

/ForecastSchedule

Returns a collection of ForecastSchedule models

7.00

 

 

Long help file not found: include/api/html/modules/ForecastSchedule/ForecaseScheduleApi.html#forecastSchedule


File:modules/ForecastSchedule/clients/base/api/ForecastScheduleApi.php
Method:forecastSchedule

 

 

+

PUT

/ForecastSchedule/:record

Updates a ForecastSchedule model

7.75

 

 

Long help file not found: include/api/html/modules/ForecastSchedule/ForecastScheduleApi.html#forecastScheduleSave


File:modules/ForecastSchedule/clients/base/api/ForecastScheduleApi.php
Method:forecastScheduleSave

 

 

+

GET

/ForecastWorksheets

Returns a collection of ForecastWorksheet models

7.00

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastWorksheet


File:modules/Forecasts/clients/base/api/ForecastsWorksheetApi.php
Method:forecastWorksheet

 

 

+

PUT

/ForecastWorksheets/:record

Updates a ForecastWorksheet model

7.75

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastWorksheet


File:modules/Forecasts/clients/base/api/ForecastsWorksheetApi.php
Method:forecastWorksheetSave

 

 

+

GET

/Forecasts/chart

Retrieve the Chart data for the given data in the Forecast Module

8.75

 

 

 

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:

DescriptionOptional
Show for a specific user, defaults to current user if not definedOptional
Show for a specific time period, defaults to the current time period if one is not passedOptional
Which Forecast dataset to show, valid values are likely, best, worst. Defaults to likely if one is not specifiedOptional
Show Which fields the y-axis shows on the chart. Can be any field in the opportunity module, defaults to Sales StageOptional
Pipeline or Committed are valid values.Optional

Param
user_id timeperiod_id dataset group_by ranges

 


File:modules/Forecasts/clients/base/api/ForecastsChartApi.php
Method:chart

+

POST

/Forecasts/committed

Commit a forecast

8.75

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommit


File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommit

 

 

+

GET

/Forecasts/committed

A list of forecasts entries matching filter criteria

8.75

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommitted


File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommitted

 

 

+

GET

/Forecasts/committed/mgrNeedsCommitted

True or False if the manager worksheet commit is older than the rep worksheet committed date.

10.50

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastWorksheetApi.html#forecastsCommittedDateCheck


File:modules/Forecasts/clients/base/api/ForecastsCommittedApi.php
Method:forecastsCommittedMgrNeedsCommitted

 

 

+

GET

/Forecasts/init

Returns current user data

8.75

 

 

Long help file not found: include/api/html/init.html


File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:forecastsInitialization

 

 

+

GET

/Forecasts/me

Returns current user

8.75

 

 

Long help file not found: include/api/html/me.html


File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:retrieveCurrentUser

 

 

+

GET

/Forecasts/progressManager

Progress Manager data

8.75

 

 

Long help file not found: modules/Forecasts/clients/base/api/help/ForecastProgressApi.html#progressRep


File:modules/Forecasts/clients/base/api/ForecastsProgressApi.php
Method:progressManager

 

 

+

GET

/Forecasts/progressRep

Progress Rep data

8.75

 

 

Long help file not found: modules/Forecasts/clients/base/api/help/ForecastProgressApi.html#progressRep


File:modules/Forecasts/clients/base/api/ForecastsProgressApi.php
Method:progressRep

 

 

+

GET

/Forecasts/reportees/:user_id

Gets reportees to a user by id

9.50

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastFiltersApi.html#reportees


File:modules/Forecasts/clients/base/api/ForecastsFiltersApi.php
Method:getReportees

 

 

+

GET

/Forecasts/timeperiod

forecast timeperiod

8.75

 

 

Long help file not found: include/api/html/modules/Forecasts/ForecastFiltersApi.html#timeperiod


File:modules/Forecasts/clients/base/api/ForecastsFiltersApi.php
Method:timeperiod

 

 

+

GET

/Forecasts/user/:userId

Returns selectedUser object for given user

9.50

 

 

Long help file not found: include/api/html/user.html


File:modules/Forecasts/clients/base/api/ForecastsCurrentUserApi.php
Method:retrieveSelectedUser

 

 

+

POST

/Leads/register

This method registers leads

8.75

 

 

 

Endpoint to create leads

 

 

Summary:

This endpoint accepts a json payload of lead properties and creates new leads.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

{ "first_name":"John", "last_name":"Smith" }

 

Output Example:

{ "id": "ecba9f86-4a4a-def6-359c-505a5b33f014", "name": "John Smith", "date_entered": "2012-09-19T23:54:54+0000", "date_modified": "2012-09-19T23:54:54+0000", "modified_user_id": "1", "created_by": "1", "deleted": 0, "team_id": "1", "team_set_id": "1", "first_name": "John", "last_name": "Smith", "full_name": "John Smith", "do_not_call": false, "converted": false, "lead_source": "Support Portal User Registration", "status": "New", "preferred_language": "en_us", "email": [], "my_favorite": false }

 


File:clients/base/api/RegisterLeadApi.php
Method:createLeadRecord

+

GET

/Meetings

Search records in this module

7.00

 

 

 

List Records In Module

 

 

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

 


File:modules/Meetings/clients/base/api/MeetingsApi.php
Method:globalSearch

+

GET

/Reports

Search Reports

7.00

 

 

 

List Records In Module

 

 

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

 


File:modules/Reports/clients/base/api/ReportsSearchApi.php
Method:globalSearch

+

GET

/Reports/:record/:export_type

This method exports a record in the specified type

8.50

 

 

No additional help.


File:modules/Reports/clients/base/api/ReportsExportApi.php
Method:exportRecord

 

 

+

GET

/Users

Search User records

7.00

 

 

 

List Records In Module

 

 

Summary:

This endpoint lists records in a specific module. Searching, filtering and ordering can be applied to only fetch the records you are interested in. Additionally the set of returned fields can be restricted to speed up processing and reduce download times.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

qSearch the records by this parameter, if you don’t have a full-text search engine enabled it will only search the name field of the records.Optional

maxResultA maximum number of records to returnOptional

offsetHow many records to skip over before records are returnedOptional

fieldsComma delimited list of what fields you want returned.
The field date_modified will always be addedOptional

order_byHow to sort the returned records, in a comma delimited list with the direction appended to the column name after a colon.
Example: last_name:DESC,first_name:DESC,date_modified:ASCOptional

favoritesOnly fetch favorite recordsOptional

deletedShow deleted records in addition to undeleted recordsOptional

 

Input Example:

This endpoint does not accept any input

 

Output Example:

{ "next_offset": 31, This will be set to -1 when there are no more records after this "page" "records": [ { "id":"514eab95-4e5b-63f1-1658-4f8c7675955c", "name":"Nelson Inc", "date_entered":"2012-04-16 19:41:10", "date_modified":"2012-04-16 19:41:10", "modified_user_id":"1", "created_by":"1","description":null, "deleted":"0", "assigned_user_id":"seed_sarah_id", "_search": { "score": "1.0", "highlighted": {"fieldName" : { "text": "My String Is here", "module":"ModuleName", "label":"LBL_AWESOME" }} }, ... additional fields ... }, ... additional records ... ] }

 


File:clients/base/api/PersonUnifiedSearchApi.php
Method:globalSearch

+

GET

/css

Generate the bootstrap.css file

7.00

 

 

 

Run LessPHP and outputs the compiled css

 

 

Summary:

This endpoint allows you to preview what would be the output bootstrap.css after compiling a theme. It interprets the arguments as less variables and run LessPHP based on the set of arguments you furnished.

 

 

Query Parameters:

 

Param Description Optional
platform /themes/clients/***PLATFORM***/themeName/ true themeName /themes/clients/platform/***THEMENAME***/ true min Compress or not the css true

 

Input Example:

{ platform: 'portal', themeName: 'default', min: false }

 

Output Example:

.article { font-size: 16px; }

 

 


File:clients/base/api/ThemeApi.php
Method:previewCSS

+

GET

/help

Shows Help information

7.00

 

 

 

Fetch Help Documentation

 

 

Summary:

This function gives you the help documentation you are looking at right now.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint accepts no parameters.

 

Input Example:

This endpoint does not accept any input

 

Output Example:

<!DOCTYPE HTML> <html> <head> <title>SugarCRM Auto Generated API Help</title> <style type="text/css"> .hidden { display: none; } .endpointMain { background: #eeeeee; } </style> <script type="text/javascript" src="../../include/javascript/jquery/jquery.js"></script> </head> <body> <h1>SugarCRM API</h1> <table id="endpointList" border=1 cellspacing=0 cellpadding=2> <tr id="endpoint_0" class="endpointMain"> <td class="showHide"><a onclick="showHideAction(this); return false;">+</a></td> <td class="reqType">GET</td> <td class="fullPath">/<module></td> <td class="shortHelp">List records in this module</td> <td class="score">4.50</td> </tr> <tr id="endpoint_0_full" class="endpointExtra hidden"> <td class="empty"> </td> <td class="fullHelp" colspan=4> ... Full help excluded ... <b>File:</b>include/api/listApi.php<br> <b>Method:</b>listModule<br> </td> </tr> ... More rows ... </table> </body> </html> Note: This endpoint returns contents of type text/html

 


File:clients/base/api/HelpApi.php
Method:getHelp

+

GET

/lang/:lang

Returns the labels for the application

7.75

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getLanguage

 

 

+

GET

/lang/public/:lang

Returns the public labels for the application

9.50

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getPublicLanguage

 

 

+

GET

/me

Returns current user

7.00

 

 

 

Provides an Current User endpoint

 

 

Summary:

This endpoint returns the current user object.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

 

 

Output Example:

{"current_user": { "type":"user", "id":"1", "full_name":"Administrator", "timepref":"h:ia", "timezone":"America/Los_Angles", "user_name":"admin" }} Or, for portal users: {"current_user": { "type":"support_portal", "id":"1234-567", "user_id":"abcd-123", "full_name":"Bill Williamson", "timepref":"h:ia", "timezone":"America/Denver", "user_name":"SupportPortalApi" }}

 


File:clients/base/api/CurrentUserApi.php
Method:retrieveCurrentUser

+

PUT

/me

Updates current user

7.00

 

 

 

Provides an Current User endpoint

 

 

Summary:

This endpoint returns the current user object.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

 

 

Output Example:

{"current_user": { "type":"user", "id":"1", "full_name":"Administrator", "timepref":"h:ia", "timezone":"America/Los_Angles", "user_name":"admin" }} Or, for portal users: {"current_user": { "type":"support_portal", "id":"1234-567", "user_id":"abcd-123", "full_name":"Bill Williamson", "timepref":"h:ia", "timezone":"America/Denver", "user_name":"SupportPortalApi" }}

 


File:clients/base/api/CurrentUserApi.php
Method:updateCurrentUser

+

POST

/me/password

Verifies current user’s password

8.75

 

 

 

Provides an enpoint to verify the Current User’s password

 

 

Summary:

This endpoint allows for verification of the user’s current password. If client type is support_portal, it will check corresponding Contact. Otherwise, it will check corresponding User.

 

Query Parameters:

 

Param

 

 

DescriptionRequired

 

 

Input Example:

{ 'password_to_verify': 'mycurrentpassword' }

 

Output Example:

{ "valid":true, }

 


File:clients/base/api/CurrentUserApi.php
Method:verifyPassword

+

PUT

/me/password

Updates current user’s password

8.75

 

 

 

Provides an enpoint to change Current User’s password

 

 

Summary:

This endpoint allows for changes the user’s password. If client type is support_portal, it will update the corrending Contact. Otherwise, it will update User.

 

Query Parameters:

 

Param

 

 

DescriptionRequired

 

 

Input Example:

{ "old_password":"myoldpass", "new_password":"mynewpass", }

 

Output Example:

{ "valid":true, "expiration":null, }

 


File:clients/base/api/CurrentUserApi.php
Method:updatePassword

+

PUT

/me/preference/:preference_name

Update a specific preference for the current user

9.50

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreferenceSave

 

 

+

DELETE

/me/preference/:preference_name

Delete a specific preference for the current user

9.50

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreferenceDelete

 

 

+

POST

/me/preference/:preference_name

Create a preference for the current user

9.50

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreferenceSave

 

 

+

GET

/me/preference/:preference_name

Returns a specific preference for the current user

9.50

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreference

 

 

+

PUT

/me/preferences

Mass Save Updated Preferences For a User

8.75

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreferencesSave

 

 

+

GET

/me/preferences

Returns all the current user’s stored preferences

8.75

 

 

Long help file not found: include/api/help/user_preferences.html


File:clients/base/api/CurrentUserApi.php
Method:userPreferences

 

 

+

GET

/metadata

This method will return all metadata for the system

7.00

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getAllMetadata

 

 

+

POST

/metadata

This method will return all metadata for the system, filtered by the array of hashes sent to the server

7.00

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getAllMetadata

 

 

+

GET

/metadata/_hash

This method will return the hash of all metadata for the system

8.75

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getAllMetadataHash

 

 

+

GET

/metadata/public

This method will return the metadata needed when not logged in

8.75

 

 

Long help file not found: include/api/html/metadata_all_help.html


File:clients/base/api/MetadataApi.php
Method:getPublicMetadata

 

 

+

POST

/oauth5/logout

OAuth5 logout.

8.75

 

 

Long help file not found: include/api/help/oauth5_logout.html


File:clients/base/api/OAuth5Api.php
Method:logout

 

 

+

POST

/oauth5/token

OAuth5 token requests.

8.75

 

 

 

Provides an OAuth 2.0 compliant token endpoint

 

 

Summary:

This endpoint provides the token portion of the OAuth 2.0 specification. Currently the only supported grant types are “password” and “refresh_token”. The client_id of “sugar” will automatically create an OAuth Key in the system and can be used for “password” authentication. The client_id of “support_portal” will create an OAuth Key if the portal system is enabled and will allow for portal authentication. Other client_id’s can be created by the administrator in the OAuthKeys section in the Administration section and can be used in the future for additional grant types, if the client secret is filled in, it will be checked to validate use of the client id.

 

Query Parameters:

 

Param

 

 

DescriptionOptional

 

This endpoint does not accept any parameters.

 

Input Example:

For "password" grant types: { "grant_type":"password", "username":"bwayne", "password":"i_am_batman", "client_id":"sugar", "client_secret":"", } For "refresh_token" grant types: { "grant_type":"refresh_token", "refresh_token":"abc123", "client_id":"sugar", "client_secret":"", }

 

Output Example:

{ "access_token":"993de20f-43d4-fbf7-8fe9-4fc6a6a7bb4b", "expires_in":3600, "token_type":"bearer", "scope":null, "refresh_token":"a39a7c6d-7276-fcf0-da64-4fc6a6976a10" }

 


File:clients/base/api/OAuth5Api.php
Method:token

+

GET

/ping

An example API only responds with pong

7.00

 

 

Long help file not found: include/api/html/ping_base_help.html


File:clients/base/api/PingApi.php
Method:ping

 

 

+

GET

/ping/whattimeisit

An example API only responds with the current time in server format.

8.75

 

 

Long help file not found: include/api/html/ping_whattimeisit_help.html


File:clients/base/api/PingApi.php
Method:ping

 

 

+

GET

/search

Globally search records

7.00

 

 

Long help file not found: include/api/help/globalSearch.html


File:clients/base/api/UnifiedSearchApi.php
Method:globalSearch

 

 

+

GET

/theme

Get the customizable variables of a custom theme

7.00

 

 

 

Get the customizable variables of a custom theme

 

 

Summary:

It parses variables.less (less file containing customizable vars in the theme folder) and returns the hash of variables

 

 

Query Parameters:

 

Param Description Optional
platform /themes/clients/***PLATFORM***/themeName/ true themeName /themes/clients/platform/***THEMENAME***/ true

 

Input Example:

{ platform: 'portal', themeName: 'default' }

 

Output Example:

{ primary: '#aaaaaa', secondary: '#bbbbbb', primaryBtn: '#cccccc' }

 


File:clients/base/api/ThemeApi.php
Method:getCustomThemeVars

+

POST

/theme

Update the customizable variables of a custom theme

7.00

 

 

 

Update the customizable variables of a custom theme

 

 

Summary:

It updates variables.less (less file containing customizable vars in the theme folder) with the set of variables passed as arguments

 

 

Query Parameters:

 

Param Description Optional
platform /themes/clients/***PLATFORM***/themeName/ true themeName /themes/clients/platform/***THEMENAME***/ true

 

Input Example:

{ platform: 'portal', themeName: 'default', primary: 'default', secondary: '#aaaaaa', primaryBtn: '#bbbbbb', }

 

Output Example:

http://path/to/bootstrap.css (json encoded)

 

 


File:clients/base/api/ThemeApi.php
Method:updateCustomTheme