Web Services
Overview
Web Services allow for communication between different applications and platforms. Sugar currently supports REST and SOAP APIs. The following sections will outline how to interact with the APIs and what versions of the API we recommend for use.
Versioning
API versioning is the process of creating a new set of API endpoints for new functionality while leaving pre-existing endpoints available for third-party applications and integrations to continue using. This helps to extend the application in an upgrade-safe manner.
Quick Reference
When working with the Web Service API, you should be using the latest REST API specific to your release. A quick reference of this can be found below:
| Release1 | REST Version | REST URL | SOAP Version2 | SOAP URL |
| 13.3.x | v11.23 | /rest/v11_23/ | v4.1 | /service/v4_1/soap.php |
| 13.2.x | v11.22 | /rest/v11_22/ | v4.1 | /service/v4_1/soap.php |
| 13.1.x | v11.21 | /rest/v11_21/ | v4.1 | /service/v4_1/soap.php |
| 13.0.x | v11.20 | /rest/v11_20/ |
v4.1 |
/service/v4_1/soap.php |
| 12.3.x | v11.19 | /rest/v11_19/ | v4.1 | /service/v4_1/soap.php |
| 12.2.x | v11.18 | /rest/v11_18/ | v4.1 | /service/v4_1/soap.php |
| 12.1.x | v11.17 | /rest/v11_17/ | v4.1 | /service/v4_1/soap.php |
| 12.0.x | v11.16 | /rest/v11_16/ | v4.1 | /service/v4_1/soap.php |
| 11.3.x | v11.15 | /rest/v11_15/ | v4.1 | /service/v4_1/soap.php |
| 11.2.x | v11.14 | /rest/v11_14/ | v4.1 | /service/v4_1/soap.php |
| 11.1.x | v11.13 | /rest/v11_13/ | v4.1 | /service/v4_1/soap.php |
| 11.0.x | v11.12 | /rest/v11_12/ | v4.1 | /service/v4_1/soap.php |
| 10.3.x | v11.11 | /rest/v11_11/ | v4.1 | /service/v4_1/soap.php |
| 10.2.x | v11.10 | /rest/v11_10/ | v4.1 | /service/v4_1/soap.php |
| 10.1.x | v11.9 | /rest/v11_9/ | v4.1 | /service/v4_1/soap.php |
| 10.0.x | v11.8 | /rest/v11_8/ | v4.1 | /service/v4_1/soap.php |
| 9.3.x | v11.7 | /rest/v11_7/ | v4.1 | /service/v4_1/soap.php |
| 9.2.x | v11.6 | /rest/v11_6/ | v4.1 | /service/v4_1/soap.php |
| 9.1.x | v11.5 | /rest/v11_5/ | v4.1 | /service/v4_1/soap.php |
| 9.0.x | v11.4 | /rest/v11_4/ | v4.1 | /service/v4_1/soap.php |
| 8.3.x | v11.4 | /rest/v11_4/ | v4.1 | /service/v4_1/soap.php |
| 8.2.x | v11.3 | /rest/v11_3/ | v4.1 | /service/v4_1/soap.php |
| 8.1.x | v11.2 | /rest/v11_2/ | v4.1 | /service/v4_1/soap.php |
| 8.0.x | v11.1 | /rest/v11_1/ | v4.1 | /service/v4_1/soap.php |
| 7.11.x | v11 | /rest/v11/ | v4.1 | /service/v4_1/soap.php |
| 7.10.x | v11 | /rest/v11/ | v4.1 | /service/v4_1/soap.php |
| 7.9.x | v10 | /rest/v10/ | v4.1 | /service/v4_1/soap.php |
| 7.8.x | v10 | /rest/v10/ | v4.1 | /service/v4_1/soap.php |
| 7.7.x | v10 | /rest/v10/ | v4.1 | /service/v4_1/soap.php |
| 6.5.x | v4.1 | /service/v4_1/rest.php | v4.1 | /service/v4_1/soap.php |
1 Some of the releases in this table may no longer be officially-supported Sugar versions, but we have included them for archival purposes. For more information, please refer to the Supported Versions resource page.
2 As of Sugar 7.0, SOAP support is no longer offered with the new APIs. The legacy APIs will remain accessible in the product, however, any existing integrations should be updated to use the latest REST endpoints.