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

Unified API (BYOK) — connector documentation

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

What Unified API (BYOK) is for

Unified API (BYOK) lets an AI assistant read your own Unified API data through the Unified API API with a key you supply (Unified workspace API key (Settings, API Keys in the Unified dashboard)). Read-only: 6 tools (list_hris_employees, list_hris_groups, list_hris_locations, list_hris_companies, list_hris_time_off, list_ats_jobs). 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.unified.to, api-eu.unified.to, api-au.unified.to. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Unified API. Unified API 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:

  • "Who works at the company according to our HR system?"
  • "What departments and teams exist in our HR system?"
  • "Which offices are in our HR system?"
  • "Which legal entities are in our HR system?"
  • "Who is on leave next week?"
  • "Which jobs are open in our ATS?"

What it does

  • list_hris_employees: List employees of a connected HR system: name, work emails, title, manager, employment status and type, employee number, hire and termination dates. Pay, birth date, gender, ID numbers, address and phone are never requested.
  • list_hris_groups: List groups (departments, teams, divisions) of a connected HR system with type, parent, members and managers.
  • list_hris_locations: List work locations of a connected HR system with address, time zone, HQ flag and parent.
  • list_hris_companies: List companies and legal entities of a connected HR system with name and address.
  • list_hris_time_off: List time off requests of a connected HR system: who, when, type, status, approver, duration. The free-text reason and comments are not requested.
  • list_ats_jobs: List jobs of a connected recruiting system: name, status, employment type, remote flag, openings, recruiters and hiring managers. Salary and compensation are not requested.

BYOK key

You bring your own Unified API Unified workspace API key (Settings, API Keys in the Unified dashboard) (https://docs.unified.to/quick-start). 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.unified.to, api-eu.unified.to, api-au.unified.to 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 Unified API API (api.unified.to, api-eu.unified.to, api-au.unified.to) with a BYOK key; documentation: https://docs.unified.to/hris/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 Unified API. Unified API 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 Unified API account.

Built for: Worldwide. Languages: English.