{"openapi":"3.1.0","info":{"title":"Clickup Structure (BYOK) API","version":"0.1.0","description":"Clickup Structure (BYOK) lets an AI assistant read your own Clickup Structure data through the Clickup Structure API with a key you supply (personal API token (starts with pk_)). Read-only: 10 tools (get_space, get_folder, get_list, list_folder_custom_fields, list_space_views, list_folder_views, list_list_views, list_folder_templates, get_goal, get_shared_hierarchy). The BYOK key travels with...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-clickup-structure.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-clickup-structure/docs"},"termsOfService":"https://connectorbay.com/byok-clickup-structure/terms"},"servers":[{"url":"https://byok-clickup-structure.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-clickup-structure/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_space":{"post":{"operationId":"get_space","summary":"Get one ClickUp space: name, privacy, multiple-assignee setting, the status workflow and which ClickUp features (due dat","description":"Get one ClickUp space: name, privacy, multiple-assignee setting, the status workflow and which ClickUp features (due dates, time tracking, tags, estimates, checklists, custom fields, portfolios) are on. Use for \"Which statuses and features 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":"get_spaceArguments","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_folder":{"post":{"operationId":"get_folder","summary":"Get one ClickUp folder: name, task count, hidden and archived flags, whether it overrides the space statuses and its sta","description":"Get one ClickUp folder: name, task count, hidden and archived flags, whether it overrides the space statuses and its statuses (use list_lists in the ClickUp connector for its lists). Use for \"What statuses does ClickUp folder 90120002 use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder ID.","maxLength":200,"title":"Folder Id","type":"string"}},"required":["folder_id"],"title":"get_folderArguments","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_list":{"post":{"operationId":"get_list","summary":"Get one ClickUp list: name, task count, due and start dates, location (folder and space), archived flag, whether it over","description":"Get one ClickUp list: name, task count, due and start dates, location (folder and space), archived flag, whether it overrides statuses and its status workflow. Description and assignee are not returned. Use for \"What statuses does ClickUp list 90120003 have and how many tasks are in it\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"List ID.","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"get_listArguments","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_folder_custom_fields":{"post":{"operationId":"list_folder_custom_fields","summary":"List the custom fields available in a folder with type, options and creation date. Use for \"Which custom fields does Cli","description":"List the custom fields available in a folder with type, options and creation date. Use for \"Which custom fields does ClickUp folder 90120002 offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder ID.","maxLength":200,"title":"Folder 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":["folder_id"],"title":"list_folder_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_views":{"post":{"operationId":"list_space_views","summary":"List the views defined at space level (board, list, calendar, gantt ...) with id, name, type and parent. ClickUp returns","description":"List the views defined at space level (board, list, calendar, gantt ...) with id, name, type and parent. ClickUp returns each view with id, name, type, parent, grouping, sorting and filter settings. Use for \"Which views does ClickUp space 90120001 have\".","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_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_folder_views":{"post":{"operationId":"list_folder_views","summary":"List the views defined on a folder with id, name, type and parent. ClickUp returns each view with id, name, type, parent","description":"List the views defined on a folder with id, name, type and parent. ClickUp returns each view with id, name, type, parent, grouping, sorting and filter settings. Use for \"Which views does ClickUp folder 90120002 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder ID.","maxLength":200,"title":"Folder Id","type":"string"}},"required":["folder_id"],"title":"list_folder_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_list_views":{"post":{"operationId":"list_list_views","summary":"List the views defined on a list with id, name, type and parent. ClickUp returns each view with id, name, type, parent, ","description":"List the views defined on a list with id, name, type and parent. ClickUp returns each view with id, name, type, parent, grouping, sorting and filter settings. Use for \"Which views 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"}},"required":["list_id"],"title":"list_list_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_folder_templates":{"post":{"operationId":"list_folder_templates","summary":"List the folder templates of a workspace with id and name. Use for \"Which folder templates does ClickUp workspace 901234","description":"List the folder templates of a workspace with id and name. Use for \"Which folder 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_folder_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}},"/v1/tools/get_goal":{"post":{"operationId":"get_goal","summary":"Get one ClickUp goal: name, dates, progress percentage, privacy, archived flag, key result ids and link. Owners and memb","description":"Get one ClickUp goal: name, dates, progress percentage, privacy, archived flag, key result ids and link. Owners and members are not returned. Use for \"How far along is ClickUp goal e53a033c\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"goal_id":{"description":"Goal ID (a UUID), from the ClickUp connector's list_goals.","maxLength":200,"title":"Goal Id","type":"string"}},"required":["goal_id"],"title":"get_goalArguments","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_shared_hierarchy":{"post":{"operationId":"get_shared_hierarchy","summary":"List the tasks, lists and folders that have been shared with the key's user in a workspace (lists and folders with name,","description":"List the tasks, lists and folders that have been shared with the key's user in a workspace (lists and folders with name, task count and dates). Use for \"What has been shared with me 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"}},"required":["team_id"],"title":"get_shared_hierarchyArguments","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}}}}