Qodex.ai

About ClickUp API

ClickUp's API is a powerful REST API that enables developers to integrate and extend ClickUp's project management capabilities. It provides comprehensive control over projects, tasks, lists, and other ClickUp entities through standardized HTTP endpoints. The API returns data in JSON format and supports both personal token and OAuth2 authentication methods. Key capabilities include:
  1. Full CRUD operations for tasks, lists, and projects
  2. Automated workflow management
  3. Custom reporting and analytics
  4. Integration with third-party tools
  5. Time tracking and management
  6. User and team administration
  7. Custom fields handling
  8. File attachment management
  9. Real-time updates via webhooks

Getting Started

  1. Obtain API Credentials
    1. Navigate to the Apps section in your ClickUp profile
    2. Click "Create New App"
    3. Name your app and create it
    4. You'll receive a Client ID and Client Secret
    5. For personal use, you can alternatively use your API token from your profile
  2. Choose Authentication Method
    • Personal Token: Suitable for individual use
      • Generate from your ClickUp profile
      • Include in Authorization header: Authorization:
        pk_123456789_ABCD1234ABCD1234
    • OAuth2 (Recommended for multi-user apps):
      • Create OAuth app in team settings > Integrations > "ClickUp API"
      • Set up redirect URL

    Implement authorization flow:
    Redirect to: https://app.clickup.com/api?client_id={client_id}&redirect_uri={redirect_uri}
    Receive authorization code
    Exchange code for access token using POST /api/v2/oauth/token
  3. Test Your Connection
    • Use tools like Postman or curl to make test API calls
    • Start with simple endpoints like GET /user
    • Verify authentication is working correctly
  4. Implement Rate Limits
    • Free/Unlimited/Business: 100 requests/minute
    • Business Plus: 1,000 requests/minute
    • Enterprise: 10,000 requests/minute

Core API Endpoints

  1. /task: Manage tasks (create, update, delete)
  2. /list: Handle task lists and Kanban boards
  3. /folder: Organize lists and spaces
  4. /team: Manage team settings and members
  5. /user: User operations and preferences
  6. /comment: Handle task and list comments
  7. /timetracking: Time entry management
  8. /webhook: Set up real-time notifications
  9. /customfield: Custom field operations
  10. /attachment: File attachment handling

Additional Resources

  • Official ClickUp API Documentation: https://clickup.com/api
  • Sample Applications in App Gallery
  • GitHub repositories with code examples (Node.js, Python, C#)
  • Interactive API Reference with "Try It" feature
  • Developer Community Forums

Support

If you have any questions, feel free to email info@apievangelist.com, or ping me at Twitter at @apievangelist. Ideally, we keep the conversation thread local within this workspace, but we are happy to answer general questions through other channels.

This is Not an Official ClickUp Workspace

This is meant to drive conversation around ClickUp APIs, but is not officially operated by ClickUp. If you work for ClickUp, please publish your own workspace and I am happy to remove this workspace and just begin forking your collections as part of stories here on API Evangelist—the community needs an OpenAPI and collections available for your APIs.