Skip to main content

Overview

To authenticate with Breeze, you need:
  1. API Token — the API token from your Breeze personal settings.
This guide will show you where to find it.

Prerequisites

  • A Breeze account. If you don’t have one, sign up: you can use Breeze free for 14 days, with no credit card required.

Step 1: Copy your API token

  1. Sign in to Breeze.
  2. Open your personal settings and click the Integrations tab.
Breeze personal settings with the Integrations tab selected
  1. Under API token, click Copy to copy your token.
Breeze Integrations tab with the Copy button next to the API token field

Step 2: Enter your API token in the Connect UI

  1. Open the form where you need to authenticate with Breeze.
  2. Enter your API token in the API Token field. Breeze needs no password with the token, so the form does not ask for one.
  3. Submit the form, and you should be successfully authenticated.
Breeze Connect UI form with the API Token field You are now connected to Breeze.