Quickstart
This guide will get you all set up and ready to use the Unlocktopus API. We'll cover how to get started with an API client and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Before you can make requests to the Unlocktopus API, you will need to grab an API key from your dashboard. You find it under Settings » API.
Choose your client
Before making your first API request, you need to pick which API client you will use. In addition to cURL HTTP requests, we offer a JavaScript SDK. In the following example, you can see how to install each client.
# cURL is most likely already installed on your machine
curl --version
Making your first API request
After picking your preferred client, you are ready to make your first call to the Unlocktopus API. Below, you can see how to send a GET request to the Licenses endpoint to get a list of all your licenses. In the cURL example, results are limited to thirty licenses, the default page length for each client.
curl -G https://api.unlocktopus.com/v0/licenses \
-H "Authorization: Bearer {token}" \
-d limit=10