{"openapi":"3.1.0","info":{"title":"Clickup Workspace Config (BYOK) API","version":"0.1.0","description":"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,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-clickup-workspace-config.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clickup-workspace-config/docs"},"termsOfService":"https://connectorbay.com/byok-clickup-workspace-config/terms"},"servers":[{"url":"https://byok-clickup-workspace-config.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clickup-workspace-config/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_workspace_plan":{"post":{"operationId":"get_workspace_plan","summary":"Get the plan a ClickUp workspace is on (plan name and id). Needs workspace owner or admin rights. Use for \"Which ClickUp","description":"Get the plan a ClickUp workspace is on (plan name and id). Needs workspace owner or admin rights. Use for \"Which ClickUp plan is workspace 9012345 on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"get_workspace_planArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workspace_seats":{"post":{"operationId":"get_workspace_seats","summary":"Get filled, total and empty member seats and the guest seats of a workspace. Needs workspace owner or admin rights. Use ","description":"Get filled, total and empty member seats and the guest seats of a workspace. Needs workspace owner or admin rights. Use for \"How many ClickUp seats are used in workspace 9012345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"get_workspace_seatsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_custom_fields":{"post":{"operationId":"list_workspace_custom_fields","summary":"List the custom fields available across a workspace (Everything level) with type, options and creation date. Use for \"Wh","description":"List the custom fields available across a workspace (Everything level) with type, options and creation date. Use for \"Which custom fields exist in ClickUp workspace 9012345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"},"include_applied_objects":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also list where each field is used.","title":"Include Applied Objects"}},"required":["team_id"],"title":"list_workspace_custom_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_space_custom_fields":{"post":{"operationId":"list_space_custom_fields","summary":"List the custom fields available in a space with type, options and creation date. Use for \"Which custom fields does Clic","description":"List the custom fields available in a space with type, options and creation date. Use for \"Which custom fields does ClickUp space 90120001 offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"space_id":{"description":"Space ID.","maxLength":200,"title":"Space Id","type":"string"},"include_applied_objects":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also list where each field is used.","title":"Include Applied Objects"}},"required":["space_id"],"title":"list_space_custom_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_list_custom_fields":{"post":{"operationId":"list_list_custom_fields","summary":"List the custom fields available on a list with type, options and creation date. Use for \"Which custom fields does Click","description":"List the custom fields available on a list with type, options and creation date. Use for \"Which custom fields does ClickUp list 90120003 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"List ID.","maxLength":200,"title":"List Id","type":"string"},"include_applied_objects":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to also list where each field is used.","title":"Include Applied Objects"}},"required":["list_id"],"title":"list_list_custom_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_custom_roles":{"post":{"operationId":"list_custom_roles","summary":"List the custom roles defined in a workspace with name, inherited base role and creation date. Enterprise plan. Use for ","description":"List the custom roles defined in a workspace with name, inherited base role and creation date. Enterprise plan. Use for \"Which custom roles does ClickUp workspace 9012345 define\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_custom_rolesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_custom_task_types":{"post":{"operationId":"list_custom_task_types","summary":"List the custom task types (for example Milestone or Bug) of a workspace with name, plural name and description. Use for","description":"List the custom task types (for example Milestone or Bug) of a workspace with name, plural name and description. Use for \"Which custom task types does ClickUp workspace 9012345 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_custom_task_typesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_user_groups":{"post":{"operationId":"list_user_groups","summary":"List user groups of a workspace with name, handle and creation date (member emails are not returned). Use for \"Which use","description":"List user groups of a workspace with name, handle and creation date (member emails are not returned). Use for \"Which user groups exist in ClickUp workspace 9012345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID.","title":"Team Id","type":"integer"}},"required":["team_id"],"title":"list_user_groupsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_space_tags":{"post":{"operationId":"list_space_tags","summary":"List the task tags defined in a space with their colors. Use for \"Which task tags does ClickUp space 90120001 use\".","description":"List the task tags defined in a space with their colors. Use for \"Which task tags does ClickUp space 90120001 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"space_id":{"description":"Space ID.","maxLength":200,"title":"Space Id","type":"string"}},"required":["space_id"],"title":"list_space_tagsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_workspace_views":{"post":{"operationId":"list_workspace_views","summary":"List the Everything-level views of a workspace (list, board, calendar and so on) with id, name and type. Use for \"Which ","description":"List the Everything-level views of a workspace (list, board, calendar and so on) with id, name and type. Use for \"Which views exist at the top level of ClickUp workspace 9012345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_workspace_viewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks of a workspace with endpoint URL, subscribed events, scope and health (the signing secret is not retur","description":"List the webhooks of a workspace with endpoint URL, subscribed events, scope and health (the signing secret is not returned). Use for \"Which ClickUp webhooks are configured in workspace 9012345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_webhooksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_list_templates":{"post":{"operationId":"list_list_templates","summary":"List the list templates saved in a workspace with id and name. Use for \"Which list templates does ClickUp workspace 9012","description":"List the list templates saved in a workspace with id and name. Use for \"Which list templates does ClickUp workspace 9012345 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Workspace ID (ClickUp calls it team_id), the number after /t/ or in the workspace URL.","maxLength":200,"title":"Team Id","type":"string"}},"required":["team_id"],"title":"list_list_templatesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}