---
title: "Unleashed API"
slug: "unleashed-api"
updated: 2023-01-03T12:23:24Z
published: 2023-01-03T12:23:24Z
canonical: "help.canary7.com/unleashed-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.canary7.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unleashed API

## Getting Credentials from Unleashed

Canary7 Unleashed Integration requires Credentials from Unleashed. Please log in to your unleashed account using the link below.

[https://go.unleashedsoftware.com/](https://go.unleashedsoftware.com/)

For this integration, you need the following:

- Your API Id
- Your API Key

1. Click on "Integration".![unleashed integration 1](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/unleashed%20integration%201.png)
2. Then click on "Unleashed API Access".![unleashed integration 2](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/unleashed%20integration%202.png)
3. Now you will see the relevant API information.![unleashed integration 3](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/unleashed%20integration%203.png)

Ensure that you have gotten the following:

- Your API Id
- Your API Key

## Adding an Unleashed Company Integration

Click on the Red Action Button![red action button](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/red%20action%20button.png), this will bring up a drop-down menu, and select "Add"

![add type](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/add%20type.png)

### Complete the General Tab

![unleashed1](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/unleashed1.png)

Select the following:

1. "Unleashed" as the integration
2. The company related to the integration

Click on ![add button](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/add%20button.png)to complete the general tab.

### Complete the Api Tab

![api general tab(1)](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/api%20general%20tab(1).png)

Select the integration Api; here are the options available:

- Order
- Item
- Receipt
- Inventory
- Disassembly To Receipt
- Disassembly To Shipment
- Assembly To Receipt
- Assembly To Shipment

Click on ![apply](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/apply.png) to continue. You can add more of these by clicking on the Red Action Button![red action button](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/red%20action%20button.png), and this will bring up a drop-down menu, and selecting "Add".

![api transform tab](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/api%20transform%20tab.png)

If needed, you can enter the Transform. If not, leave it blank and click ![apply](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/apply.png)to continue.

### Complete the Credential Tab

![unleashed2](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/unleashed2.png)

Enter the following [with the information obtained above](https://help.canary7.com/docs/unleashed-api#getting-credentials-from-unleashed)

1. application_api_id (Your API Id)
2. application_api_key (Your API Key)

Ensure that this information is correct and click on![Save button](https://cdn.document360.io/4ed7d884-d42a-4c7e-a949-08033b57dc86/Images/Documentation/Save%20button.png) to add this Unleashed integration for this company.