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

Capsule Setup (BYOK) — connector documentation

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

What Capsule Setup (BYOK) is for

Capsule Setup (BYOK) lets an AI assistant read your own Capsule Setup data through the Capsule Setup API with a key you supply (Capsule personal access token). Read-only: 10 tools (list_tag_definitions, list_custom_field_definitions, list_boards, list_board_stages, list_lost_reasons, list_task_categories, list_activity_types, list_teams, list_track_definitions, list_currencies). 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.capsulecrm.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Capsule Setup. Capsule Setup 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 tags exist on Capsule contacts?"
  • "What custom fields are defined on Capsule opportunities?"
  • "Which Capsule boards do we have?"
  • "What stages does Capsule board 34 have?"
  • "Which lost reasons are defined in Capsule?"
  • "Which task categories exist in Capsule?"

What it does

  • list_tag_definitions: List the tags defined for contacts (parties), opportunities or projects (kases) with name, description and whether it is a data tag.
  • list_custom_field_definitions: List custom field definitions for contacts (parties), opportunities or projects (kases): name, type (text, number, date, list, boolean), description, order, capture rule and list options. No field values.
  • list_boards: List project boards (visual workflows) with name, description and dates.
  • list_board_stages: List the stages of one board in display order with name and description.
  • list_lost_reasons: List the reasons an opportunity can be lost with name and whether it counts for conversion.
  • list_task_categories: List task categories with name and colour.
  • list_activity_types: List activity types (note, meeting, call and custom ones) with name, icon and whether they update the last contacted date.
  • list_teams: List teams with name and dates. Members are not requested.
  • list_track_definitions: List track definitions (task sequences that start from a tag) with description, tag, capture rule, direction and dates. Task step details are not picked.
  • list_currencies: List the ISO currency codes Capsule supports for opportunity values, with symbol and name.

BYOK key

You bring your own Capsule Setup Capsule personal access token (https://developer.capsulecrm.com/v2/overview/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.capsulecrm.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 Capsule Setup API (api.capsulecrm.com) with a BYOK key; documentation: https://developer.capsulecrm.com/v2/operations/Custom_Field. 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 Capsule Setup. Capsule Setup 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 Capsule Setup account.

Built for: Worldwide. Languages: English.