Quickstart

This guide will get you all set up and ready to use the Buckets API. We'll cover how to get started with an API key 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.

Checking cURL Installation

Before making your first API request, you need to make sure cURL is installed. You may also want to access our API using your framework's HTTP client support, in which case the JSON payloads and routes still apply.

# cURL is most likely already installed on your machine
curl --version

Making your first API request

After checking cURL installation, you are ready to make your first call to the Buckets API. Below, you can see how to send a GET request to the Buckets endpoint to get a list of all your buckets. In the cURL example, results are limited to 100 buckets, the default page length for each request.

curl -G https://api.usebuckets.io/v1/buckets \
  -H "Authorization: Bearer {token}"

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Buckets API:

• Grab your API key from the Buckets dashboard
• Check out the Buckets endpoint
• Learn about the different error messages in Buckets