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

Box Hero (BYOK) — connector documentation

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

What Box Hero (BYOK) is for

Box Hero (BYOK) lets an AI assistant read your own Box Hero data through the Box Hero API with a key you supply (Box Hero API token (one per team)). Read-only: 11 tools (get_team, list_items, get_item, list_item_attributes, list_locations, list_partners, list_transactions, get_transaction, list_purchase_orders, get_purchase_order, list_sales_orders). 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 rest.boxhero-app.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Box Hero. Box Hero 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 Box Hero team is this token for?"
  • "What items do I have in Box Hero and how many are in stock?"
  • "Show Box Hero item 123 with its stock by location"
  • "What custom fields do my Box Hero items have?"
  • "Which locations do I have in Box Hero?"
  • "Who are my suppliers in Box Hero?"

What it does

  • get_team: Get the team linked to the token: name, mode, currency and price decimal places. Use it to check the token works.
  • list_items: List inventory items with SKU, barcode, cost, price, total quantity and the quantity at each location. The team must be in LOCATION mode.
  • get_item: Get one item by ID with SKU, barcode, cost, price, custom attributes and stock per location. The team must be in LOCATION mode.
  • list_item_attributes: List the custom attribute definitions (text, date, number, barcode) set up for items.
  • list_locations: List the active stock locations with the total quantity held at each. The team must be in LOCATION mode.
  • list_partners: List business partners (suppliers and customers): ID, type and name.
  • list_transactions: List stock transactions (in, out, move, adjust), newest first, with locations, partner, item count and total quantity. The team must be in LOCATION mode.
  • get_transaction: Get one stock transaction with every line: item, SKU, quantity moved and the new stock level after it. The team must be in LOCATION mode.
  • list_purchase_orders: List purchase orders, newest first, with supplier, status, total, item count and quantity. Lines come from get_purchase_order. The team must be in LOCATION mode.
  • get_purchase_order: Get one purchase order with its lines, prices, taxes, extra costs and how much has been received. The team must be in LOCATION mode.
  • list_sales_orders: List sales orders, newest first, with customer, status, total, item count and quantity. The team must be in LOCATION mode.

BYOK key

You bring your own Box Hero Box Hero API token (one per team) (https://www.boxhero.io/docs/developers/api/quickstart). 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 rest.boxhero-app.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.

Data sources

Live from the Box Hero API (rest.boxhero-app.com) with a BYOK key; documentation: https://www.boxhero.io/docs/developers. 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 Box Hero. Box Hero 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 Box Hero account.

Built for: Worldwide. Languages: English.