Pipedrive is a sales CRM. We have no intention of making accounting software, marketing automation software, invoicing software or software that automatically orders fresh coffee to be delivered every time you book a meeting with a client (although someone should definitely make that).
However, we do realize that our users often need a range of other software to run their businesses successfully, and to this end we’ve always insisted in providing a free, open Application Programming Interface (API).
We encourage users and other software developers to build integrations with our software, so much so that there are already over 100 such app integrations in the Marketplace.
As it became more popular, we realized that our old API Reference interface needed a drastic overhaul. It worked fine once you figured it out, but it looked ugly as sin and was not the most user friendly.
Enter the new Pipedrive API Reference
The first thing you’ll notice when landing on the new page is the complete cosmetic makeover.
We really put a lot of thought into making it easy for you to find what you’re looking for, and we trust this will pay off.
We’ve added a full list of all the endpoints on the left, with a convenient search bar at the top. This endpoint search allows you to search by endpoint name and URL, so you should find what you’re looking for in a flash.
To make sure you always know what section or endpoint you are on we’ve built a sticky page header with the endpoint group name and endpoint name prominently displayed. This gives you instant context and helps you navigate with ease.
It’s not just a pretty face
Had we simply changed the look and feel of the page, you’d be forgiven for shrugging and saying: “So what?” - So we enhanced the API Reference on mobile.
Whereas before you would simply see the desktop version on mobile, we’ve now made it fully responsive.
You can now use mobile devices without experiencing any issues with font size or scrolling.
Of course, you will need your company API token before you can start playing around with the endpoints on this page, so we made finding and saving that a priority as well - you can enter the token at the top of the page or while testing the endpoint.
Once you get the response to your request, you’ll be presented with a logical, user friendly layout, with collapsible JSON elements and its syntax highlighted for ease of reading.
We’ve also made it very easy to copy the JSON code to your clipboard, with a handy button that means you don’t have to highlight long sections of code.
We realize that a lot of our users will work on specific projects where they need to access only a few endpoints repeatedly over a few days, even weeks.
To save time, you can favorite endpoints, which means you can jump straight in without needing to search every time.
In addition, you can seamlessly jump between favorites, which is particularly useful when data from one endpoint is the input for another.
How do I get it?
It’s already live for all users. Go check it out.
We look forward to seeing what you build and, as always, we value your feedback highly.
If you’d like to keep up to date with all the tech happenings at Pipedrive, sign up for our developers newsletter at the top of the API Reference page.
We promise we won’t send you any marketing fluff, just interesting news and opinions from the developer team at Pipedrive.
This article was published on June 20, 2017. Product descriptions were correct at the time of publishing.