API Documentation

Buckets is a developer-first API for receiving, transforming, and sending files via SFTP. These docs will take you through the process of using the API to start accepting your first files from clients.

Getting started

To get started, create a new API key in your dashboard, then read about how to make requests for the resources you need to access using our HTTP APIs.

Get your API key

Guides

Authentication

Learn how to authenticate your API requests.

Pagination

Understand how to work with paginated responses.

Errors

Read about the different types of errors returned by the API.

Environments

Understand the two different environments offered by Buckets.

Identifiers

Read about the different types of identifiers used by Buckets.

Notifications

Learn how to programmatically configure notifications for your app.

Resources

Buckets

Learn about the bucket model and how to create, retrieve, update, delete, and list buckets.

Users

Learn about the user model and how to create, retrieve, update, delete, and list users.

Notifications

Learn about the notification model and how to subscribe to different platform events.