Platform Reference

Authentication, base URL, pagination, errors, and other API reference documentation.

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, including your password and user secret.
Authentication
To authenticate with , you need to include your Organization Secret and User Secret as headers with each request. When interacting with instances, you will typically need an instance token instead of an Organization Secret. When you create an acc...
Authorization Headers, Organization Secret, and User Secret
Authenticate your account by including your User Secret and either your Organization Secret, Instance Token, or both in the Authorization header of API requests.  Always refer to the Authorization parameters of the API docs for each request, ...
Base URL
The base URL differs depending on your region and environment:
Error Codes
error messages take a few forms depending on whether the error occurs with platform API requests or API provider responses to API requests. Platform Errors Platform errors include: HTTP response code — The response codes follow the ge...
Standardized Pagination
In general, there are three types of pagination that every API uses: 1. page and pageSize 2. limit and offset 3. cursor We try to create a standard means of paginating in each , and in general page and pageSize is our preferred method becaus...
Role-Based Access Control to Element Instances
The platform allows users to view, use, modify, and delete instances from the same account, provided the user has a role with one or more of these privileges active: Permission Description viewAccountElementInstances Ability to view ins...
Usage Limits
The below tables in this article  indicates the various usage limits of the platform and to which environments they apply. Click here to review Upcoming Usage Limits.   Limit Name Limit Description Scope max request siz...
Upcoming Usage Limits
The below tables in this article indicates the upcoming usage limits of the platform and their scheduled dates for the different environments. The dates at which these usage limits will be implemented are TBD; check this space for updates. To se...