> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickUp API

> Find, create and update ClickUp tasks, subtasks, checklists, Custom Fields, comments and Docs in an agent

> [!NOTE]
>
> Automatically enabled when you configure ClickUp permissions in your agent workflow.

## What it does

* Find the Space, Folder or List an agent works in, and search tasks there by status, assignee, tag, dates or Custom Field
* Read a task with its subtasks, checklists, Custom Fields, comments and attachments
* Create tasks and subtasks, and set assignees, status, priority, due dates, tags and Custom Field values
* Add and tick checklist items, comment on tasks, and attach files
* Read ClickUp Docs and their pages, add a page, and add to one
* Log time, update goals, and manage Lists, Folders and views, as the permission groups allow. Safety Controls below lists what always asks

Every task Neo creates or reads comes back with its ClickUp ID and link, so the agent can write them on the ticket and find the same task on a later run.

Neo acts as the ClickUp user who made the personal API token: it sees and changes only the Spaces, Folders, Lists, tasks and Docs that user can open. Neo removes webhook signing secrets from every answer.

## Choose where each agent works

Name the Space, Folder or List in the agent's instructions, for example "Create onboarding tasks in the List *Onboarding* in the Space *Service Desk*". The agent finds it by name and works there. To keep every agent out of a part of your Workspace, connect ClickUp with the token of a user who cannot open that part: ClickUp itself then refuses each call there.

## Start an agent on ClickUp changes

ClickUp events do not start a Neo agent. Run the agent on a schedule, for example every 15 minutes: each run asks ClickUp for the tasks created or changed since the last run, in the Lists it watches, and acts on each one. Tell it in its instructions which changes to act on, such as "a task moved to *Ready for Neo*".

## Permission groups

| Group | Covers |
| - | - |
| Tasks, Subtasks & Checklists | Searching and reading tasks, creating, updating, moving, merging and deleting tasks and subtasks, status, assignees, priority, dates, tags, dependencies, links, Custom Field values, checklists, attachments and task templates. Also the Workspace members and Custom Field definitions a task change needs |
| Comments & Chat | Comments on tasks, Lists and Chat views and their replies, and ClickUp Chat channels and messages |
| Docs | Docs and their pages |
| Spaces, Folders, Lists & Views | Spaces, Folders, Lists, views, Space tags, List and Folder templates |
| Time Tracking | Time entries, their tags and history |
| Goals | Goals and key results |
| Members, Guests & Access | Workspace members and guests, user groups, custom roles, seats and plan, guest access and the sharing of any item |
| Webhooks & Audit Logs | Webhooks and the Workspace audit log (Enterprise) |

Each group can be Disabled, Read Only or Read / Write, with or without a technician's approval for changes.

| Profile | What it does |
| - | - |
| Read Only | Reads every group, changes nothing |
| Helpdesk | Creates and updates tasks, checklists and comments on its own; Doc changes ask a technician first; the other groups read only |
| IT Admin | Changes on its own, except members, access and webhooks, which ask a technician first, and those Safety Controls lists |
| Full Automation | Every change with no approval, except those Safety Controls lists |

## Safety Controls

These always ask a technician, whatever the profile:

* Deleting a Space, a Folder or a List, which deletes every task in it
* Every change to Workspace members and guests, user groups, guest access and sharing, because each can add a paid seat or open data to someone
* Making a Space no longer private, or creating or changing a Doc or a Chat channel with any visibility but private
* Creating or updating a webhook, which sends Workspace data to an outside address

Neo never calls ClickUp's OAuth token exchange.

## Setup

See [Connecting ClickUp to Neo](https://docs.neoagent.io/integrations/clickup/connecting-to-neo.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.