Platform Reference

Articles

User Profile
Your profile includes the basic information about yourself, like your name and email. It also includes critical information that you need to authenticate with Sugar Integrate including your password and user secret. You can reset your password and u...
Authentication
When you authenticate with Sugar Integrate, you need to include your Organization Secret and User Secret as headers with each request. When interacting with adapter instances, you will typically need an an adapter instance token instead of an Organi...
Authorization Headers, Organization Secret, and User Secret
Authenticate your account by including your User Secret and either your Organization Secret, Adapter Instance Token, or both in the Authorization header of API requests.  Always refer to the Authorization parameters of the API docs for each re...
Base URL
The Sugar Integrate base URL differs depending on your region and environment: Region Production Environment Staging Environment North America https://api-us.integrate.sugarapps.com/elements/api-v2 https://api-us-staging.integrate...
Error Codes
Sugar Integrate error messages take a few forms depending on whether the error occurs with platform API requests or API provider responses to adapter API requests. Platform Errors Platform errors include: HTTP response code — The respons...
Pagination
Pagination is used to save us the trouble of having to go through more number of records than necessary. It makes us easier to handle the results of any API calls that have been made. There are three common types of pagination that every API uses: ...
Usage Limits
The below tables in this article  indicates the various usage limits of the Sugar Integrate platform and to which environments they apply. Procedures Limit Name Limit Description Scope Procedure max request size 5 MB This is the ...