Skip to main content

ClickUp Doc

Type ID: clickupDoc  ·  Kind: Action  ·  Ports: 1 in, 1 out

Create and read ClickUp Docs.

Credentials​

Connect a ClickUp credential via the integration picker.

{
"credentials": {
"name": "clickup",
"id": "<credential-id>"
}
}

Resources & operations​

  • Doc (doc)
    • Create (create) - Create a new Doc
    • Read (read) - Read a Doc's metadata and page content

For agent integrations (name: 'clickupDoc' in permissions.integrations), grant '*', a resource key, or an operation key — see Tools and Permissions:

Resource key (<resource>)Operation keys (<resource>.<operation>)
docdoc.create, doc.read

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsYesdocDoc (doc)-
OperationoperationoptionsYescreateCreate (create), Read (read)resource = doc

Doc → Create​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Workspace IDworkspaceIdstringYes''ID of the ClickUp Workspace (Team) to create the Doc inresource = doc, operation = create
NamenamestringYes''Name of the new Docresource = doc, operation = create
Parent TypeparentTypeoptionsYes12Workspace (12), Space (4), Folder (5), List (6)resource = doc, operation = create
Parent IDparentIdstringNo''ID of the Space/Folder/List to create the Doc under. Leave blank when Parent Type is Workspace.resource = doc, operation = create
ContentcontentstringNo''Optional Markdown content for the Doc's first page (created when "Create Page" is true)resource = doc, operation = create

Doc → Read​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Workspace IDworkspaceIdstringYes''ID of the ClickUp Workspace (Team) the Doc belongs toresource = doc, operation = read
Doc IDdocIdstringYes''ID of the ClickUp Doc to readresource = doc, operation = read

Notes​

  • When creating a Doc with initial content, the node first creates the Doc and then makes a follow-up call to write the content to the Doc's first page.
  • Read operation returns the Doc metadata and a flattened array of all pages within the Doc.