iPaaS.com is API-first: everything you can do in the platform can be done through the REST API. This guide is your starting point, tying together every API service, where to explore it, and how to authenticate.
Before you start: Read API Introduction for important context on working safely with the API, then follow Accessing the API to authenticate.
The API Services
The iPaaS.com REST API is organized into services, each with its own interactive Swagger (OpenAPI) documentation where you can explore and test endpoints directly:
Service | What it covers |
Authenticate, switch companies, and manage user roles and permissions. Start here. | |
Create and manage templated integrations between iPaaS.com and third-party software. | |
Customers, their addresses, and their company associations. | |
Products including variants and kits, category trees, and inventory across locations and location groups. | |
Transactions and associated data: line items, shipping, tax, addresses, payments, and notes. | |
Employees and their timesheets. | |
Gift card creation and activity. | |
Create and update integrations via the API. | |
Configure an integration to authenticate via OAuth and parse webhooks sent to iPaaS.com by external systems. | |
Broadcast messages from iPaaS.com to third-party systems, such as errors to Slack or Microsoft Teams. | |
Interact with iPaaS.com logs. | |
Pull data about subscriptions, hooks, and systems. |
Prefer Postman? Explore and test the APIs with the official iPaaS.com Postman Collection.
Authentication in Brief
Authenticate with your iPaaS.com credentials or an API key via the SSO service. Because users operate across multiple companies, authorization is at the company level: log in, retrieve your companies, then generate a company-specific access token. API keys come preconfigured with all approved company authorizations. The full step-by-step walkthrough is in Accessing the API, and API key creation is covered in API Keys.
Your API permissions match your iPaaS.com UI permissions. Include your access token in the Authorization header on every request.
Request Essentials
Base URL pattern: each service is rooted at api.ipaas.com (for production), for example api.ipaas.com/subscriptions/v2 for the Subscription service.
Errors: error messages are returned as plaintext in the response body.
Rate limits: 429 responses occur for monthly API limits (based on your billing plan) or temporary volume restrictions; the error message specifies which.
Pagination: list endpoints return an X-Pagination header with total_Count, page_Size, current_Page, and total_Pages.
Compatibility: iPaaS.com does not expect to launch API versions or endpoints that are not backwards compatible.