Skip to main content

Getting Started

Welcome to the Bloomflow Public API documentation. It will help you to get started fast. If you run into problems, you can contact us at customer@bloomflow.com

Introduction

Our Public API is designed to enable teams of any shape or size to build robust integrations that help them customize and get the most value out of Bloomflow.

All Bloomflow APIs are built using REST conventions and designed to have a predictable URL structure. They use many standard HTTP features, including methods (POST, GET, PUT, DELETE) and error response codes.

info

All Bloomflow API calls are made under your customer url: https://api.YOUR_CUSTOMER_NAME.bloomflow.com/api/public/

All responses return standard JSON.

Setting up

Credentials

Bloomflow APIs use API key authorization to ensure that client requests access data securely. With API key auth, you send a key-value pair to the API in the request headers for every call:

  • Request header must have a x-bflow-api-key field containing the API key
info

When you are ready to work with the public API ask your credentials by contacting us at customer@bloomflow.com