Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Breeze (BYOK) — connector documentation

  • MCP endpoint: https://byok-breeze.connectorbay.com/mcp
  • REST API: POST https://byok-breeze.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-breeze.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Breeze Breeze API key, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-breeze.connectorbay.com/health · Tool schemas: https://byok-breeze.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-breeze · agent@connectorbay.com

What Breeze (BYOK) is for

Breeze (BYOK) lets an AI assistant read your own Breeze data through the Breeze API with a key you supply (Breeze API key). Read-only: 15 tools (get_account_summary, list_people, get_person, list_profile_fields, list_tags, list_tag_folders, list_events, list_calendars, list_locations, list_attendance, list_volunteers, list_volunteer_roles, list_forms, list_form_fields, list_form_entries). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to *.breezechms.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Breeze. Breeze and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Breeze account is my key connected to?"
  • "Who is in my Breeze people database?"
  • "Show Breeze person 157857"
  • "Which profile fields exist for people in Breeze?"
  • "Which tags do I have in Breeze?"
  • "How are my Breeze tags organised into folders?"

What it does

  • get_account_summary: Show the Breeze account the key belongs to: name, subdomain, status, time zone and country.
  • list_people: List people in the database, optionally with full profile details; use limit and offset to page.
  • get_person: Get one person by Breeze id, with profile details when requested.
  • list_profile_fields: List the profile sections and the fields in each section that your Breeze people records use.
  • list_tags: List the tags used to group people, optionally only those inside one tag folder.
  • list_tag_folders: List the tag folders with their parent folder.
  • list_events: List calendar events in a date range, optionally for one calendar.
  • list_calendars: List the event calendars with their names and colours.
  • list_locations: List the locations (rooms) that events can use.
  • list_attendance: List who was checked in to one event instance, or the anonymous head count.
  • list_volunteers: List the volunteers scheduled for one event instance with their response and role ids.
  • list_volunteer_roles: List the volunteer roles defined for one event instance, with the number of people requested.
  • list_forms: List the forms, active ones or archived ones.
  • list_form_fields: List the fields of one form.
  • list_form_entries: List the submissions of one form; set details to 1 to include each answer.

BYOK key

You bring your own Breeze Breeze API key (https://app.breezechms.com/api). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to *.breezechms.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Notices

Breeze documents the API at app.breezechms.com/api; the key is sent in the Api-key header. Event answers can lag the live site by up to 15 minutes, as the provider caches them.

Data sources

Live from the Breeze API (*.breezechms.com) with a BYOK key; documentation: https://app.breezechms.com/api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Breeze. Breeze and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Breeze account.

Built for: Worldwide. Languages: English.