Authentication

The Breezy API supports two authentication methods. Personal Access Tokens (PATs) are recommended for integrations and automated workflows. Session tokens from the /v3/signin endpoint are supported but better suited for interactive or short-lived sessions.

All requests (except /v3/signin and /v3/health) require an Authorization header.

Personal Access Tokens (Recommended)

A PAT is a long-lived credential tied to your user account. Unlike session tokens, PATs don't expire on signout and are ideal for integrations, scripts, and tools like the Breezy MCP.

Creating a PAT:

  1. Click your user icon in the lower-left of the Breezy app
  2. Go to My Settings
  3. Select the API Keys tab
  4. Click Create API Key and give it a name
  5. Copy the token

Using a PAT:

curl https://api.breezy.hr/v3/companies \
  -H "Authorization: breezy_pat_your_token_here"
GET /v3/companies HTTP/1.1
Host: api.breezy.hr
Authorization: breezy_pat_your_token_here

NOTE : PATs have the prefix breezypat and are only shown once — Copy and store yours securely before closing the dialog.

Session Tokens

Obtain a session token by calling POST /v3/signin with your email and password. The returned access_token is used the same way:

curl https://api.breezy.hr/v3/companies \
  -H "Authorization: your_access_token_here"

Session tokens are invalidated when you call GET /v3/signout.