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

Clickup Workspace Config (BYOK) — connector documentation

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

What Clickup Workspace Config (BYOK) is for

Clickup Workspace Config (BYOK) lets an AI assistant read your own Clickup Workspace Config data through the Clickup Workspace Config API with a key you supply (personal API token (starts with pk_)). Read-only: 12 tools (get_workspace_plan, get_workspace_seats, list_workspace_custom_fields, list_space_custom_fields, list_list_custom_fields, list_custom_roles, list_custom_task_types, list_user_groups, list_space_tags, list_workspace_views, list_webhooks, list_list_templates). 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.clickup.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Clickup Workspace Config. Clickup Workspace Config 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 ClickUp plan is workspace 9012345 on?"
  • "How many ClickUp seats are used in workspace 9012345?"
  • "Which custom fields exist in ClickUp workspace 9012345?"
  • "Which custom fields does ClickUp space 90120001 offer?"
  • "Which custom fields does ClickUp list 90120003 have?"
  • "Which custom roles does ClickUp workspace 9012345 define?"

What it does

  • get_workspace_plan: Get the plan a ClickUp workspace is on (plan name and id). Needs workspace owner or admin rights.
  • get_workspace_seats: Get filled, total and empty member seats and the guest seats of a workspace. Needs workspace owner or admin rights.
  • list_workspace_custom_fields: List the custom fields available across a workspace (Everything level) with type, options and creation date.
  • list_space_custom_fields: List the custom fields available in a space with type, options and creation date.
  • list_list_custom_fields: List the custom fields available on a list with type, options and creation date.
  • list_custom_roles: List the custom roles defined in a workspace with name, inherited base role and creation date. Enterprise plan.
  • list_custom_task_types: List the custom task types (for example Milestone or Bug) of a workspace with name, plural name and description.
  • list_user_groups: List user groups of a workspace with name, handle and creation date (member emails are not returned).
  • list_space_tags: List the task tags defined in a space with their colors.
  • list_workspace_views: List the Everything-level views of a workspace (list, board, calendar and so on) with id, name and type.
  • list_webhooks: List the webhooks of a workspace with endpoint URL, subscribed events, scope and health (the signing secret is not returned).
  • list_list_templates: List the list templates saved in a workspace with id and name.

BYOK key

You bring your own Clickup Workspace Config personal API token (starts with pk_) (https://app.clickup.com/settings/apps). 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.clickup.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 Clickup Workspace Config API (api.clickup.com) with a BYOK key; documentation: https://developer.clickup.com/reference/getauthorizedteams. 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 Clickup Workspace Config. Clickup Workspace Config 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 Clickup Workspace Config account.

Built for: Worldwide. Languages: English.