Clickup

ClickUp

Interact with ClickUp using their REST API.

Setup

1. Check existing credentials:

   vault_get clickup_api_token
   

2. If not configured:

   • Go to https://app.clickup.com/settings/apps
   • Generate an API Token
   • Save to vault:

     vault_save clickup_api_token "pk_xxx"
     

   The token is auto-injected as $CLICKUP_API_TOKEN.

Get Authorized User & Workspaces

# Get user info
curl -s "https://api.clickup.com/api/v2/user" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.user'

# Get workspaces (teams)
curl -s "https://api.clickup.com/api/v2/team" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.teams[]'

# Get spaces in workspace
curl -s "https://api.clickup.com/api/v2/team/TEAM_ID/space" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.spaces[]'

# Get lists in space
curl -s "https://api.clickup.com/api/v2/space/SPACE_ID/list" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.lists[]'

Tasks

# Get tasks from list
curl -s "https://api.clickup.com/api/v2/list/LIST_ID/task" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.tasks[]'

# Get task details
curl -s "https://api.clickup.com/api/v2/task/TASK_ID" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.'

# Get tasks with filters
curl -s "https://api.clickup.com/api/v2/list/LIST_ID/task?status[]=Open&due_date_lt=1735689600000" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.tasks[]'

Create Task

curl -s -X POST "https://api.clickup.com/api/v2/list/LIST_ID/task" \
  -H "Authorization: $CLICKUP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Implement authentication",
    "description": "Add OAuth2 support",
    "priority": 2,
    "due_date": 1735689600000,
    "assignees": [USER_ID]
  }' | jq '.'

Update Task

# Update task
curl -s -X PUT "https://api.clickup.com/api/v2/task/TASK_ID" \
  -H "Authorization: $CLICKUP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated task name", "status": "in progress"}'

# Close/complete task
curl -s -X PUT "https://api.clickup.com/api/v2/task/TASK_ID" \
  -H "Authorization: $CLICKUP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status": "complete"}'

Comments

# Add comment
curl -s -X POST "https://api.clickup.com/api/v2/task/TASK_ID/comment" \
  -H "Authorization: $CLICKUP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"comment_text": "Great progress!"}'

# Get comments
curl -s "https://api.clickup.com/api/v2/task/TASK_ID/comment" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.comments[]'

Time Tracking

# Start time entry
curl -s -X POST "https://api.clickup.com/api/v2/team/TEAM_ID/time_entries/start" \
  -H "Authorization: $CLICKUP_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tid": "TASK_ID"}'

# Stop time entry
curl -s -X POST "https://api.clickup.com/api/v2/team/TEAM_ID/time_entries/stop" \
  -H "Authorization: $CLICKUP_API_TOKEN"

# Get time entries
curl -s "https://api.clickup.com/api/v2/team/TEAM_ID/time_entries?task_id=TASK_ID" \
  -H "Authorization: $CLICKUP_API_TOKEN" | jq '.data[]'

Tips

• Priority: 1=Urgent, 2=High, 3=Normal, 4=Low
• Dates are Unix timestamps in milliseconds
• Status names depend on your ClickUp workspace configuration
• Use include_closed=true to get completed tasks

Triggers

clickup, clickup task, create clickup task, clickup api, clickup list

Converted and distributed by TomeVault — claim your Tome and manage your conversions.