Capsule API

App Showcase

Take a look at a range of apps that integrate with Capsule

What's New

We make regular updates to the API, see what's new

Getting Started

To help you develop your ideas before you start committing code to your project, it’s useful to use a command line tool like curl to help you experiment with the API. Curl comes pre-installed on macOS and most Linux distributions, and can be downloaded for Windows from the curl website. If you’re downloading Curl, be sure to select a package with SSL support. We’ll use Curl throughout the examples in this section.

Here are a few steps to help you get started:

  1. Authentication
  2. Reading from the API
  3. Writing to the API
  4. Handling API responses

Note: Migrating from Capsule API v1 to v2

Capsule API v2 is our latest API. If you have an existing application that was built against Capsule API v1 then take a look at our migration guide for advice on upgrading your integration. The improvements we have made in API v2 will help make your existing integration simpler and faster.