View as Markdown
ClickUp icon

ClickUp ACTION

Get Lists

Get a list of lists. See the documentation in Lists / Get Lists section.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ClickUp account once, then configure and run Get Lists from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "clickup-get-lists",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    clickup: { authProvisionId: "apn_xxxxxxx" },
    workspaceId: "Workspace",
    spaceId: "Space",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Lists inputs
Property Type Description
workspaceId Workspace string
The id of a workspace
Required Dynamic
spaceId Space string
The id of a space
Required Dynamic
folderId Folder string
The id of a folder
Required Dynamic
archived Archived boolean
Filter for archived lists
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
clickup-get-lists
Version
0.0.12
App
ClickUp
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes