Introduction

​

Base URL

The Buster API is built on REST principles and HTTPS is enforced for all requests. The API does not support HTTP.

All requests are made to the following base URL:

https://api.buster.so/api/v1

​

Identifiers

You will notice that many of the endpoints require an external parameter. In an attempt to keep you from having to store UUIDs from Buster, we enable you to use custom identifiers. These identifiers can be anything you want, but they must be unique to your account. For example, you could use a user’s email address or a unique ID from your database.

​

Authentication

To authenticate you need to add a api-key header with the contents of the header being your API key. You can find your API key in your account settings.

api-key: 809b134a-ee37-430a-9ba8-f755187e7e93

​

Response codes

Buster uses conventional HTTP response codes to indicate success or failure of your requests.

In general, 2xx codes indicate success, 4xx codes indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.), and 5xx codes indicate an error with Buster’s servers (these are rare).

​

FAQ