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
- Create (
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>) |
|---|---|
doc | doc.create, doc.read |
Properties
Common
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Resource | resource | options | Yes | doc | Doc (doc) | - |
| Operation | operation | options | Yes | create | Create (create), Read (read) | resource = doc |
Doc → Create
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Workspace ID | workspaceId | string | Yes | '' | ID of the ClickUp Workspace (Team) to create the Doc in | resource = doc, operation = create |
| Name | name | string | Yes | '' | Name of the new Doc | resource = doc, operation = create |
| Parent Type | parentType | options | Yes | 12 | Workspace (12), Space (4), Folder (5), List (6) | resource = doc, operation = create |
| Parent ID | parentId | string | No | '' | ID of the Space/Folder/List to create the Doc under. Leave blank when Parent Type is Workspace. | resource = doc, operation = create |
| Content | content | string | No | '' | Optional Markdown content for the Doc's first page (created when "Create Page" is true) | resource = doc, operation = create |
Doc → Read
| Property | Key | Type | Required | Default | Possible values | Applies when |
|---|---|---|---|---|---|---|
| Workspace ID | workspaceId | string | Yes | '' | ID of the ClickUp Workspace (Team) the Doc belongs to | resource = doc, operation = read |
| Doc ID | docId | string | Yes | '' | ID of the ClickUp Doc to read | resource = 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.