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

Close Setup (BYOK) — connector documentation

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

What Close Setup (BYOK) is for

Close Setup (BYOK) lets an AI assistant read your own Close Setup data through the Close Setup API with a key you supply (Close API key). Read-only: 10 tools (list_lead_custom_fields, list_contact_custom_fields, list_opportunity_custom_fields, list_opportunity_statuses, list_smart_views, list_sequences, list_email_templates, list_call_outcomes, list_roles, list_groups). 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.close.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Close Setup. Close 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:

  • "What custom fields are defined on leads in Close?"
  • "What custom fields are defined on contacts in Close?"
  • "What custom fields are defined on opportunities in Close?"
  • "Which opportunity statuses exist in my Close pipelines?"
  • "Which Smart Views do we have in Close?"
  • "Which sales sequences are active in Close?"

What it does

  • list_lead_custom_fields: List the custom field definitions for leads: id, name, description, type (text, number, date, datetime, choices, user, contact, hidden and more), allowed choices and whether several values are allowed. No field values from records.
  • list_contact_custom_fields: List the custom field definitions for contacts: id, name, description, type (text, number, date, datetime, choices, user, contact, hidden and more), allowed choices and whether several values are allowed. No field values from records.
  • list_opportunity_custom_fields: List the custom field definitions for opportunities: id, name, description, type (text, number, date, datetime, choices, user, contact, hidden and more), allowed choices and whether several values are allowed. No field values from records.
  • list_opportunity_statuses: List opportunity statuses across pipelines: id, label, pipeline id and type (active, won or lost).
  • list_smart_views: List saved Smart Views with id, name, record type (lead, contact, opportunity, call, email and more), description, shared flag and dates. The filter query is not returned.
  • list_sequences: List email and call sequences with id, name, status and dates. Steps are not picked.
  • list_email_templates: List email templates with id, name, subject, shared and archived flags and dates. Template bodies are not returned.
  • list_call_outcomes: List call and meeting outcomes with id, name, description, type (custom or vm-dropped) and whether they apply to calls or meetings.
  • list_roles: List the roles defined for the organization with id, name, whether the role can be edited and its permissions.
  • list_groups: List user groups (teams) with id and name. Members are not requested.

BYOK key

You bring your own Close Setup Close API key (https://developer.close.com/api/overview/api-key-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.close.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 Close Setup API (api.close.com) with a BYOK key; documentation: https://developer.close.com/api/resources/custom-fields.md. 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 Close Setup. Close 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 Close Setup account.

Built for: Worldwide. Languages: English.