126 things your agent can do in ClickUp

Get accessible custom fields

Retrieves all accessible custom field definitions for a specified clickup list using its `list id`.

Get access token

Exchanges a clickup oauth 2.0 authorization code (obtained after user consent) for an access token.

Get all tags from time entries

Retrieves all unique tags applied to time entries within a specified clickup team (workspace).

Get authorized teams workspaces

Retrieves a list of workspaces (teams) the authenticated user can access.

Get authorized user

Retrieves the details of the currently authenticated clickup user.

Get bulk tasks time in status

Retrieves the time spent in each status for multiple tasks; requires the 'total time in status' clickapp to be enabled in the workspace.

Get chat view comments

Retrieves comments from a specified chat view in clickup, supporting pagination via `start` and `start id` to fetch comments older than the default 25 most recent.

Get custom roles

Retrieves all custom roles, which allow granular permission configurations, for a specified workspace (team).

Get custom task types

Retrieves all custom task types available within a specified workspace (team id).

Get filtered team tasks

Retrieves a paginated list of tasks (up to 100 per page) from a specified team (workspace id in `team id`) based on various filter criteria, respecting user access permissions.

Get folder

Retrieves detailed information about a specific folder in clickup.

Get folderless lists

Retrieves all lists within a specified space that are not located in any folder.

Get folders

Retrieves folders within a specified clickup space, ensuring `space id` is valid, with an option to filter by archived status.

Get folder views

Retrieves all configured views (like list, board, calendar) for a specified, existing folder in clickup.

Get goal

Retrieves detailed information for an existing clickup goal, specified by its unique `goal id`.

Get goals

Retrieves goals for a specified clickup workspace (team); the `team id` must be valid and accessible.

Get guest

Call this to retrieve detailed information for a specific guest within a team (workspace), ensuring the `guest id` is valid for the given `team id`; this action requires the clickup enterprise plan.

Get list

Retrieves detailed information for an existing list in clickup, identified by its unique `list id`.

Get lists

Retrieves all lists within a specified, existing clickup folder, optionally filtering by archived status.

Get list comments

Retrieves comments for a specific clickup list, supporting pagination using `start` (timestamp) and `start id` (comment id) to fetch earlier comments; omits them for the latest 25.

Get list members

Retrieves all members of a specific, existing clickup list by its id.

Get list views

Retrieves all task and page views for a specified and accessible clickup list.

Get running time entry

Retrieves the currently active time entry for a user in a workspace; a negative 'duration' in its data indicates it's running, and the response may be empty if no entry is active.

Get singular time entry

Fetches a specific time entry by its id for a given team; a negative duration in the response indicates an active timer.

Get space

Retrieves detailed information for an existing space in a clickup workspace, identified by its unique space id.

Get spaces

Retrieves spaces for a team id; member information for private spaces is returned only if the authenticated user is a member.

Get space tags

Retrieves all tags for tasks within a specified clickup space, requiring a valid `space id`.

Get space views

Retrieves all task and page views for a specified space id in clickup.

Get task

Retrieves comprehensive details for a clickup task by its id, supporting standard or custom task ids (requires `team id` for custom ids).

Get tasks

Retrieves tasks from a specified clickup list; only tasks whose home is the given list id are returned.

Get task comments

Retrieves up to 25 comments for a specified task, supporting pagination using `start` and `start id` to fetch older comments.

Get task members

Retrieves users with explicit access (directly assigned or shared) to a specific existing task, excluding users with inherited permissions.

Get task s time in status

Retrieves the duration a task has spent in each status, provided the 'total time in status' clickapp is enabled for the workspace.

Get task templates

Retrieves task templates for a specified workspace (team id), supporting pagination.

Get teams

Retrieves user groups (teams) from a clickup workspace, typically requiring `team id` (workspace id), with an option to filter by `group ids`.

Get time entries within a date range

Retrieves time entries for a specified team (workspace id) within a date range (defaults to the last 30 days for the authenticated user if dates are omitted); active timers are indicated by negative…

Get time entry history

Retrieves the modification history for an existing time entry within a specific clickup team (workspace).

Get tracked time

Retrieves tracked time for a task using a legacy endpoint; prefer newer time tracking api endpoints for managing time entries.

Get user

Retrieves detailed information for a specific user within a clickup workspace (team), available only for workspaces on the clickup enterprise plan.

Get view

Fetches details for a specific clickup view, identified by its `view id`, which must exist.

Get view tasks

Retrieves all tasks visible in a specified clickup view, respecting its applied filters, sorting, and grouping.

Get webhooks

Fetches webhooks for a team (workspace), returning only those created by the authenticated user via api, for a `team id` they can access.

Get workspace everything level views

Retrieves all task and page views at the 'everything level' (a comprehensive overview of all tasks across all spaces) for a specified clickup workspace.

Get workspace plan

Retrieves the details of the current subscription plan for a specified clickup workspace.

Get workspace seats

Retrieves seat utilization (used, total, available for members/guests) for a clickup workspace (team) id, which must be for an existing workspace.

Add dependency

Adds a 'waiting on' or 'blocking' dependency to a task, requiring either `depends on` (task becomes waiting on) or `dependency of` (task becomes blocking), but not both; `team id` is required if `cus…

Add guest to folder

Adds a guest to a folder with specified permissions; requires a clickup enterprise plan.

Add guest to list

Shares a clickup list with an existing guest user, granting them specified permissions; requires the workspace to be on the clickup enterprise plan.

Add guest to task

Assigns a guest to a task with specified permissions; requires clickup enterprise plan, and `team id` if `custom task ids` is true.

Add tags from time entries

Associates a list of specified tags with one or more time entries within a given team (workspace).

Add tag to task

Adds an existing tag to a specified task; team id is required if custom task ids is true.

Add task link

Links two existing and accessible clickup tasks, identified by `task id` (source) and `links to` (target).

Add task to list

Adds an existing task to an additional clickup list; the "tasks in multiple lists" clickapp must be enabled in the workspace for this.

Create a time entry

Creates a new time entry for a specified team.

Create checklist

Creates a new checklist with a specified name within an existing task, which can be identified by its standard id or a custom task id (if `custom task ids` is true, `team id` is also required).

Create checklist item

Creates a new checklist item within a specified, existing checklist, optionally setting the item's name and assigning it to a user.

Create folder

Creates a new clickup folder within the specified space, which must exist and be accessible.

Create folderless list

Creates a new folderless list (a list not part of any folder) directly within a specified clickup space.

Create folder view

Creates a new, highly customizable view within a specific clickup folder using its `folder id`.

Create goal

Creates a new goal in a clickup team (workspace).

Create key result

Creates a new key result (target) for a specified goal in clickup to define and track measurable objectives towards achieving that goal.

Create list

Creates a new list in clickup within a specified, existing folder.

Create list view

Creates a new, customizable view (e.g., list, board, calendar) within a specified clickup list, requiring an existing list id accessible by the user.

Create space

Creates a new space in a clickup team, with customizable name, privacy, color, and feature settings.

Create space tag

Creates a new tag (name, foreground color, background color) in an existing clickup space.

Create space view

Creates a customizable view (e.g., list, board, gantt) within a specified clickup space, allowing configuration of grouping, sorting, filtering, and display settings.

Create a task

Creates a new clickup task in a specific list, optionally as a subtask if a `parent` task id (which cannot be a subtask itself and must be in the same list) is provided.

Create task attachment

Uploads a file as an attachment to a specified clickup task, requiring `multipart/form-data` for file upload.

Create task from template

Creates a new task in a specified clickup list from a task template, using the provided name for the new task.

Create team

Creates a new team (user group) with specified members in a workspace; member ids must be for existing users, and be aware that adding view-only guests as paid members may incur extra charges.

Create webhook

Creates a clickup webhook for a team (workspace) to notify a public url on specified events (at least one, or '*' for all), optionally scoped to a space, folder, list, or task; the endpoint must acce…

Create workspace Everything level view

Creates a new, customizable view (e.g., list, board) at the 'everything' level for a specified team (workspace id), encompassing all tasks within that workspace.

Delete a time entry

Deletes an existing time entry, specified by `timer id`, from a workspace identified by `team id`.

Delete checklist

Permanently deletes an existing checklist identified by its `checklist id`.

Delete checklist item

Permanently deletes an existing item, identified by `checklist item id`, from an existing checklist, identified by `checklist id`.

Delete dependency

Removes two dependency links for `task id`: one where `task id` is blocked by `depends on`, and another where `dependency of` is blocked by `task id`; `team id` is required if `custom task ids` is tr…

Delete folder

Permanently and irreversibly deletes a specified folder and all its contents (lists, tasks) if the folder id exists.

Delete goal

Permanently removes an existing goal, identified by its `goal id`, from the workspace.

Delete key result

Deletes an existing key result, also referred to as a target within a goal, identified by its `key result id`.

Delete list

Permanently deletes an existing list and all its contents; this action is destructive and irreversible via the api.

Delete space

Permanently deletes a specified space in clickup; this action is irreversible as the space cannot be recovered via the api.

Delete space tag

Deletes a tag from a space, identified by `tag name` in path; precise matching of tag details in the request body (`tag name 1`, `tag tag fg`, `tag tag bg`) is generally required for successful delet…

Delete task

Permanently deletes a task, using its standard id or a custom task id (requires `custom task ids=true` and `team id`).

Delete task link

Deletes an existing link, effectively a dependency or relationship, between two clickup tasks; set `custom task ids=true` and provide `team id` if using custom task ids.

Delete team

Permanently deletes an existing team (user group) from the workspace using its `group id`.

Delete time tracked

Deletes a time-tracked interval from a task; use this legacy endpoint for older time tracking systems.

Delete view

Permanently and irreversibly deletes an existing view in clickup, identified by its `view id`.

Delete webhook

Permanently removes an existing webhook, specified by its id, thereby ceasing all its event monitoring and notifications.

Edit checklist

Updates an existing checklist's name or position, identified by its `checklist id`.

Edit checklist item

Updates an existing checklist item, allowing modification of its name, assignee, resolution status, or parent item for nesting.

Edit guest on workspace

Modifies the details and permissions of an existing guest user within a specific workspace.

Edit key result

Updates an existing key result's progress or note in clickup, where the key result measures progress towards a goal.

Edit space tag

Updates an existing tag's name and colors in a clickup space; requires current tag name for identification, and new values for tag name, foreground color, and background color, all of which are manda…

Edit time tracked

Edits a legacy time-tracked interval for a task (identified by `task id` and `interval id`) to update its start/end times and duration; `team id` is required if `custom task ids` is true.

Edit user on workspace

Updates a user's username, admin status, or custom role in a workspace; requires the workspace to be on an enterprise plan.

Remove custom field value

Removes an existing value from a custom field on a specific task; this does not delete the custom field definition or its predefined options.

Remove guest from folder

Revokes a guest's access to a specific clickup folder, optionally unsharing items explicitly shared with them within it; requires an enterprise plan.

Remove guest from list

Revokes a guest's access to a specific list, provided the guest currently has access to this list and the workspace is on the clickup enterprise plan.

Remove guest from task

Revokes a guest's access to a specific task; only available for workspaces on the clickup enterprise plan.

Remove guest from workspace

Permanently removes a guest from a specified workspace, revoking all their access; this destructive operation requires the workspace to be on the clickup enterprise plan.

Remove tags from time entries

Removes tags from specified time entries in a team, without deleting the tags from the workspace.

Remove tag from task

Removes a tag from a specified task by disassociating it (does not delete the tag from workspace), succeeding even if the tag is not on the task.

Remove task from list

Removes a task from an extra list (not its home list); the 'tasks in multiple lists' clickapp must be enabled.

Remove user from workspace

Deactivates a user from a specified clickup workspace, revoking their access (user can be reactivated later); requires the workspace to be on an enterprise plan.

Set custom field value

Sets or updates a custom field's value for a task; the new value (with type-dependent structure, e.g., `{"value": "text"}` or `{"value": 123, "value options": {"currency type":"usd"}}`) is provided i…

Update a time entry

Updates an existing clickup time entry; provide `start` and `end` times together, and include `team id` as a query param (request field `team id 1`) if `custom task ids` is true.

Update folder

Updates the name of an existing folder in clickup.

Update goal

Updates attributes of an existing clickup goal, identified by its `goal id`.

Update list

Updates attributes of an existing clickup list, such as its name, content, due date, priority, assignee, or color status, identified by its `list id`.

Update space

Updates an existing clickup space, allowing modification of its name, color, privacy, and feature settings (clickapps).

Update task

Updates attributes of an existing task; `team id` is required if `custom task ids` is true, use a single space (" ") for `description` to clear it, and provide at least one modifiable field.

Update team

Updates an existing clickup user group (team) using its `group id`; note that adding a view-only guest as a paid member may incur charges.

Update view

Updates an existing clickup view's settings such as name, type, grouping, or filters; ensure `parent id` and `parent type` define a valid hierarchy, and that specified field names (e.g. for sorting,…

Update webhook

Updates the endpoint url, monitored events, and status of an existing webhook, identified by its `webhook id`.

Create chat view comment

Posts a new comment to a specified clickup chat view; the 'view id' must correspond to an existing and accessible chat view.

Create list comment

Adds a new comment with specific text to an existing and accessible clickup list, assigns it to a user, and sets notification preferences for all list members.

Create task comment

Adds a comment to a clickup task; `team id` is required if `custom task ids` is true.

Delete comment

Deletes an existing comment from a task using its `comment id`.

Invite guest to workspace

Invites a guest by email to a clickup workspace (team) on an enterprise plan, setting initial permissions and optionally a custom role; further access configuration for specific items may require sep…

Invite user to workspace

Invites a user via email to a clickup workspace (team), optionally granting admin rights or a custom role; requires an enterprise plan for the workspace.

Update comment

Updates an existing task comment's text, assignee (who must be a valid workspace member), or resolution status, requiring a valid existing comment id.

Change tag names from time entries

Updates the name, background color, and/or foreground color for an existing time entry tag, identified by its current `name` and `team id`.

Shared hierarchy

Retrieves the hierarchy of tasks, lists, and folders shared with the authenticated user within an existing clickup team (workspace), identified by its `team id`.

Start a time entry

Starts a new time entry (timer) in the specified team (workspace), optionally associating it with a task, adding a description, setting billable status, or applying tags (tags feature requires busine…

Stop a time entry

Stops the authenticated user's currently active time entry in the specified team (workspace), which requires an existing time entry to be running.

Track time

Records a time entry for a task using clickup's legacy time tracking system; newer endpoints are generally recommended.