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

HR Partner (BYOK) — connector documentation

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

What HR Partner (BYOK) is for

HR Partner (BYOK) lets an AI assistant read your own HR Partner data through the HR Partner API with a key you supply (HR Partner company API key (API access must be switched on in the company)). Read-only: 12 tools (get_company, list_employees, get_employee, list_leave_requests, get_leave_request, list_leave_balances, list_checklists, list_goals, list_job_listings, list_training, list_anniversaries, get_lookup_list). 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.hrpartner.io. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by HR Partner. HR Partner 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 HR Partner company is this key for and how many active employees does it have?"
  • "Which active employees work in the Sales department?"
  • "Show the HR Partner record for employee code BLENA"
  • "Which leave requests are waiting for approval?"
  • "Show HR Partner leave request 144"
  • "How much annual leave does employee A12345 have left?"

What it does

  • get_company: Show the HR Partner company the key belongs to: name, subscription expiry, employee limit, total and active employee counts and time zone.
  • list_employees: List employees with code, name, status flags, department, location, group, position, employment status and start and end dates. Pay, tax and birth data are left out. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • get_employee: Get one employee by employee code: name, status flags, department, location, group, position, employment status, manager code and start and end dates. Pay, tax, birth, custom, contact and address data are left out.
  • list_leave_requests: List leave requests with leave policy, status, start and end dates, duration and the employee. Free-text reasons and approver notes are left out. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • get_leave_request: Get one leave request by its id with policy, status, dates, duration and the employee. Free-text reasons and notes are left out.
  • list_leave_balances: List leave balances per employee and leave policy: entitlement, current balance, carry-over and units. The calculation can be slow, so filter by employee or department. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • list_checklists: List onboarding and other checklists assigned to employees with name, status, assignment and completion dates and progress percentage. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • list_goals: List goals with scope, type, description, target and current value, completion flags and due date. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • list_job_listings: List job listings with title, summary, location, department, position, employment status, publish dates, active flag and view count.
  • list_training: List employee training records with training type, course, institution, dates, status and the employee. Comments and costs are left out. Not paged: the answer is cut to the first 100 records, so narrow it with filters.
  • list_anniversaries: List active employees with their work anniversaries in a month range: name, position, start date and years worked.
  • get_lookup_list: Get one of HR Partner's dropdown lists (departments, locations, positions, leave types, tags, training types and more) to find valid filter values.

BYOK key

You bring your own HR Partner HR Partner company API key (API access must be switched on in the company) (https://developer.hrpartner.io/#authentication). 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.hrpartner.io 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 HR Partner API (api.hrpartner.io) with a BYOK key; documentation: https://developer.hrpartner.io/. 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 HR Partner. HR Partner 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 HR Partner account.

Built for: Worldwide. Languages: English.