Clickup · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clickup Docs API

9 actions 9 updates phrasing extends openapi/clickup-docs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clickup's API. It is a proposal applied on top of the contract, not a document Clickup publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/api/v3/workspaces/{workspace_id}/docs'].get
$.paths['/api/v3/workspaces/{workspace_id}/docs'].post
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}'].get
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/page_listing'].get
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages'].get
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages'].post
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}'].get
$.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}'].put

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clickup Docs API
  version: 1.0.0
extends: openapi/clickup-docs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the Docs in a Workspace
      effect: read
      questions:
      - How do I find the Docs in my ClickUp Workspace?
      - Can I search for Docs created by a specific person or under a particular parent?
      - Are deleted or archived Docs included when I search?
      instructions:
      - text: Search Docs in Workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Find Docs in Workspace {workspace_id} created by user {creator}.
        slots:
          workspace_id: path.workspace_id
          creator: query.creator
      - text: List archived Docs under parent {parent_id} in Workspace {workspace_id}.
        slots:
          parent_id: query.parent_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Doc
      effect: write
      questions:
      - How do I create a new Doc in a Workspace?
      - Can I set a Doc's visibility and parent location when I create it?
      instructions:
      - text: Create a Doc named {name} in Workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: path.workspace_id
      - text: Create a {visibility} Doc called {name} under {parent} in Workspace {workspace_id}.
        slots:
          visibility: requestBody.visibility
          name: requestBody.name
          parent: requestBody.parent
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get information about a Doc
      effect: read
      questions:
      - What details can I get about a single Doc?
      - Can I look up a Doc by its ID?
      instructions:
      - text: Get Doc {doc_id} in Workspace {workspace_id}.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      - text: Show information about Doc {doc_id} in Workspace {workspace_id}.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/page_listing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Doc's page outline
      effect: read
      questions:
      - How can I see the structure of pages in a Doc without their content?
      - Can I limit how deep the page listing goes?
      instructions:
      - text: Get the page listing for Doc {doc_id} in Workspace {workspace_id}.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      - text: Show the page tree of Doc {doc_id} in Workspace {workspace_id} to depth {max_page_depth}.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          max_page_depth: query.max_page_depth
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch all pages of a Doc with content
      effect: read
      questions:
      - How do I pull every page of a Doc along with its content?
      - Can I get a Doc's pages back as markdown?
      instructions:
      - text: Fetch all pages of Doc {doc_id} in Workspace {workspace_id}.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      - text: Get the pages of Doc {doc_id} in Workspace {workspace_id} in {content_format} format.
        slots:
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          content_format: query.content_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a page to a Doc
      effect: write
      questions:
      - How do I add a new page to an existing Doc?
      - Can I create a sub-page under another page in a Doc?
      instructions:
      - text: Create page {name} in Doc {doc_id} of Workspace {workspace_id}.
        slots:
          name: requestBody.name
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      - text: Add a sub-page {name} under page {parent_page_id} in Doc {doc_id}, Workspace {workspace_id}, with content {content}.
        slots:
          name: requestBody.name
          parent_page_id: requestBody.parent_page_id
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          content: requestBody.content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single page from a Doc
      effect: read
      questions:
      - How do I read one specific page of a Doc?
      - Will a Doc page look exactly the same when exported as markdown?
      instructions:
      - text: Get page {page_id} of Doc {doc_id} in Workspace {workspace_id}.
        slots:
          page_id: path.page_id
          doc_id: path.doc_id
          workspace_id: path.workspace_id
      - text: Read page {page_id} in Doc {doc_id} of Workspace {workspace_id} as {content_format}.
        slots:
          page_id: path.page_id
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          content_format: query.content_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages/{page_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a page in a Doc
      effect: write
      questions:
      - Can I append to a Doc page instead of replacing its content?
      - How do I rename a page inside a Doc?
      instructions:
      - text: Rename page {page_id} in Doc {doc_id}, Workspace {workspace_id}, to {name}.
        slots:
          page_id: path.page_id
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          name: requestBody.name
      - text: Update page {page_id} of Doc {doc_id} in Workspace {workspace_id} with {content} using edit mode {content_edit_mode}.
        slots:
          page_id: path.page_id
          doc_id: path.doc_id
          workspace_id: path.workspace_id
          content: requestBody.content
          content_edit_mode: requestBody.content_edit_mode
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/clickup-docs-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.