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

Breezy HR (BYOK) — connector documentation

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

What Breezy HR (BYOK) is for

Breezy HR (BYOK) lets an AI assistant read your own Breezy HR data through the Breezy HR API with a key you supply (Breezy personal access token (starts with breezy_pat_)). Read-only: 10 tools (list_companies, get_company, list_positions, get_position, get_position_stream, list_departments, list_categories, get_pipeline, list_questionnaires, list_message_templates). 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 api.breezy.hr. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Breezy HR. Breezy HR 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 Breezy companies can I access?"
  • "Show my Breezy company profile"
  • "Which positions are published at our company?"
  • "Show the details and description of one Breezy position"
  • "When did this position change state?"
  • "What departments exist in our Breezy account?"

What it does

  • list_companies: List the Breezy companies your token's user belongs to, with company id, name, friendly id, member count and dates. Use the _id in the other tools.
  • get_company: Get one Breezy company's profile: name, friendly id, member count and dates.
  • list_positions: List a company's positions (job requisitions) with name, state, type, location, department, requisition id and dates; filter by state and page with page_size.
  • get_position: Get one position with its name, state, type, experience level, location, department, category, requisition id, dates and description text.
  • get_position_stream: Show a position's activity stream: when it was added, updated or changed state, with the old and new state. Acting user names are not returned.
  • list_departments: List the departments defined for a company (id and name).
  • list_categories: List the position categories available to a company (id and name).
  • get_pipeline: Get the ordered stages of a hiring pipeline (id, name, stage type). Use 'default' or 'default_pool' for the built-in pipelines.
  • list_questionnaires: List the questionnaires configured for a company (id and name only).
  • list_message_templates: List the saved message templates of a company (id and name only, without the body text).

BYOK key

You bring your own Breezy HR Breezy personal access token (starts with breezy_pat_) (https://developer.breezy.hr/reference/authorization). 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 api.breezy.hr 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.

Data sources

Live from the Breezy HR API (api.breezy.hr) with a BYOK key; documentation: https://developer.breezy.hr/reference/overview. 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 Breezy HR. Breezy HR 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 Breezy HR account.

Built for: Worldwide. Languages: English.