The Holded API is a tool that allows Holded to communicate and share information with other applications. It is like a "translator" that helps different programs work together and share information easily.
You can integrate Holded in a generic way with other applications, however, the API is very useful in cases where you want to make a customised integration between Holded and another application commonly used in your company (e.g. Amazon). This way you can automate the use of the platform as much as possible.
Generate and use the Holded API
In order to use the Holded API you will need to generate an API Key that will allow you to identify your Holded account and transfer information between applications. To do this, follow these steps:
Go to Menu > Settings in the top right corner.
In the More section, click on Developers.
Click + New API Key.
Enter the name you want to give to the key in the Description field.
We recommend that the name refers to the application you want to integrate with Holded (e.g. E-commerce).
Click Save.
This action will generate an alphanumeric code that you can copy by hovering over it:
Consult the API documentation
Once you have generated the API Key, it is advisable to consult the API documentation to find out which sections of Holded are available for integration:
Go to Menu > Settings in the top right corner.
In the More section, click on Developers.
Click > API Documentation.
Check the available actions and elements to work with within each of the sections in the API:
Section | Data with available actions |
Billing | Contacts, Contact Groups, Products, Warehouses, Taxes, Treasury, Numbering Lines, Expense Accounts, Sales Channels, Payments, Documents, Remittances and Services. |
CRM | Funnels, Events and Leads. |
Projects | Projects, Tasks and Time Records. |
Team | Employees and Timekeeping. |
Accounting | Journal and Chart of Accounts. |
Testing using Postman
Before final integration, we recommend that you test using Postman, a tool that allows you to verify the necessary functionality:
Download the Postman test application.
Check if the functionalities you need are operational.
After carrying out the corresponding tests, and if everything works correctly, you will be able to carry out the API integration in a definitive way.