The Unleashed API allows third-party platforms and applications to connect to your Unleashed account using your account's unique API ID and Key. This guide covers how to access your credentials, manage API usage, and troubleshoot common issues.
Go to Unleashed API Documentation for a complete endpoint and resource reference.
API credentials
To find your account's unique API ID and Key:
Log in to Unleashed as the Account Owner.
Go to Integration > Unleashed API Access.
Your unique API ID and Key will be displayed for viewing and copying.
API security
Only the Account Owner can access the account's API credentials.
The API ID and Key are unique to each account, including each Sandbox account, and cannot be changed or refreshed.
Unleashed cannot block a third-party integration's connection once credentials are shared. We recommend only sharing your account's API credentials with trusted third parties.
🤓 Tip: Consider using a Sandbox account during the development of third-party integrations, instead of your live account, as it will provide a safe testing environment for developers, and changes don't affect your live data.
API Requirements
Each request through the API must include these five values, sent as HTTP headers:
Content-Type: This must be either "application/xml" or "application/json".
Accept: This must be either "application/xml" or "application/json".
api-auth-id: Enter your API ID in this header.
api-auth-signature: Generate a unique method signature per request for this header.
client-type: Enter platform the call has generated from or through. Use the format: {partner_name/app_name} or {account_name/app_name}.
For further guidance, see API Authentication.
API Usage Limits
An "API call" is any request sent to or received from your Unleashed account via a third-party connection. Your subscription will include a base usage limit for how many API calls can be made to your account per month.
The following platform integrations are exempt from API usage limits:
Prospect CRM
Mintsoft
Xero
Quickbooks
Magento
Lightspeed
eCommerce Hub: Shopify, Amazon, WooCommerce
Extra API Usage
If you reach the limit before usage resets on the first of each month, no further API calls can be made for the remainder of the month unless you add an API Extra Usage Bundle to your plan to increase your monthly limit.
API usage limits | Medium subscription | Large subscription | Large Plus subscription |
The subscription's included monthly API usage limit | 125,000 | 250,000 | 500,000 |
The API Extra Usage Bundle's usage limit, per subscription | 125,000 | 250,000 | 500,000 |
If you're approaching your monthly limit, you can purchase additional API calls:
Go to Settings > Billing.
Next to Products, select Modify.
In the Extra API Bundle tile, select Add.
Review the billing summary and select Update.
Accept the Terms & Conditions.
Click Upgrade.
📌 Note: Extra API Bundles are subscription-based and will automatically renew unless removed from your account.
Frequently asked questions
Why is an API call giving a 403 error?
Why is an API call giving a 403 error?
A 403 error response in the API means that the authentication signature posted with the call is incorrect and needs to be generated again. A 403 error response is triggered if one of the following statements are true:
The authentication signature (auth-signature) has been generated incorrectly.
The API ID and Key used to generate the auth-signature do not match the account's API ID and Key.
For instance, you cannot use the same auth-signature for: https://api.unleashedsoftware.com/v2/StockOnHand?ProductCode=BOOKSHELF as we use for: https://api.unleashedsoftware.com/v2/StockOnHand.
Why is the Date Format from a GET request different from a POST request?
Why is the Date Format from a GET request different from a POST request?
The format shown from the JSON GET request is a Unix time code format Microsoft .NET JSON, e.g., "/Date(1600300800000)/", which Unleashed is unable to accept. However, JSON POST requests (input) require the following format "yyyy-MM-ddTHH:mm:ss.fff", see our API documentation.