Quickstart

This quickstart guide will help you make your first API request and show you where to find additional resources. All of our endpoints are standard HTTP RESTful APIs.

Getting your API key

Before you can make requests to the Flowbrite API, you’ll need to obtain an API key from your dashboard. You can find it under Settings » Developer.

You can create and label multiple API keys. If you’re integrating with an external application, we recommend generating a dedicated key for each integration. This makes it easy to manage and revoke access for individual applications without impacting others.

Once you have your API key, you can use it to authenticate your requests by including it in the X-API-KEY header.

Which Environment?

Flowbrite operates two environments: Production and Sandbox.

The Sandbox environment is a safe space to test your API calls without affecting your production data. You will need to create API keys for each environment.

The base URLs are as follows:

Message Format

The Flowbrite API uses JSON for request and response bodies.

When making requests, ensure you set the Content-Type header to application/json.

A successful request will return an 2xx status code, and any response body will be wrapped in a data object or data[] array as appropriate. Where applicable, the response will also include a meta object containing additional metadata about the response, such as pagination details.

{
  "data": {
    "id": "ben_D01JTK7HZWS9E5XR4J819XF4KS5",
    "client": {
      "id": "cli_D01JTK7H3SZEEP3KVHA1ZFFRYDD",
      "name": "Joanna Bloggs"
    }
  }
}

If an error occurs, the response will be in the 4xx or 5xx range and will include an errorCode, responseCode and message properties. There may also be additional properties, such as validationErrors, depending on the type of error.

For example:

{
  "error": {
    "status": 400,
    "code": "api.search.invalidQuery",
    "message": "Cannot search this entity by field 'madeUp.property'"
  }
}

What’s next?

We'd definitely recommend reading the rest of the Guides section to get a complete understanding of the API, but it should hopefully feel pretty familiar if you've used other RESTful APIs before.

If you're eager to get started, maybe take a look at the Clients » WhoAmI endpoint to see your own account details.