Welcome to the UPTIQ Business Health Developer Platform — use our APIs to build a seamless data experience for your users.
Business Health APIs are RESTful and stateless: predictable, resource-oriented URLs, standard HTTP verbs and response codes, and every request authenticated with an API token obtained via the get token method.
With the Business Health API, you can create a connection link so your users can share their business data, use webhooks to receive that data as it arrives, and build on raw or normalized data — or the ready-to-use endpoints — to create custom experiences for your end users.
Use Cases
Why use our REST APIs:
- Build your own UI/UX on top of Raw, Normalized, and Ready-to-Use data.
- Access data from the business applications your users connect, through one API interface.
- Give your end users a secure, self-service way to share their business data.
Getting Started
This is where the magic begins! Here's how to get started building your integration:
- Obtain your JWT access token.
- Use the access token to make your API requests.
Follow these simple instructions to make your first call in minutes, or keep reading to learn more.
Host
Business Health API has one primary URL for Production.
Custom Base URLBusiness Health API offers two deployment options: SaaS (Business Health site) or CPE (customer premises equipment). Therefore, the host URL may vary for different environments.
Production Base URL
https://app.upswot.comTenants
Business Health is deployed as a multi-tenant SaaS solution: a single environment serves every tenant on shared, centrally-maintained infrastructure, with each tenant integrated physically but separated logically.
Tenants aren't distinguished by subdomain. The default (master) tenant is reached at the production base URL with /admin appended; a specific child tenant adds its alias after that:
https://app.upswot.com/admin
https://app.upswot.com/admin/{tenant_alias}Request and Response Format
Business Health APIs use the create, read, update, and delete (CRUD) basic operations through POST, GET, PUT, and DELETE requests, and return responses in a standard JSON data format.
Errors
Error handling varies depending on the API or tool you're using. If your request causes an error, the response contains an error object with information to help you resolve the problem. For webhooks, if our request to your URL or web application fails for any reason, we'll keep trying.
For details about how our APIs handle errors, see the Errors page.