ClickUp
Create, find and update ClickUp tasks, lists and folders, comment, track time, and manage checklists, tags, goals and dependencies.
Connect ClickUp
- In the sidebar, open Connections and press Add connection.
- Type
clickupand choose ClickUp. - Choose Sign in with ClickUp.
- Press Sign in with ClickUp at the bottom of the sheet, then choose your account in ClickUp’s window and allow access.
Or choose Paste your personal API token, paste it, and press Test and save. It stays until someone deletes it.
Sign in with ClickUp and tick the Workspaces the connection may use, or paste a personal API token (ClickUp → your avatar → Settings → Apps → API Token; it starts with pk_).
What if it says “Sign-in isn’t set up here yet”?
Signing in with ClickUp needs a ClickUp app on this installation, and it has none yet. Until it is set up, Paste your personal API token works without it.
On Cloud: The sheet says “It’s set up once for everyone who uses this service, not by an organization.”
Self-hosted: An admin of the installation sees Set up ClickUp sign-in instead, and sets it up once for everyone. Everyone else sees who to ask.
- Create an app in ClickUp’s developer settings (ClickUp’s guide).
- In GoRunner, copy the Redirect address to add in ClickUp’s developer settings, and add it to the app.
- Paste the Client ID and Client secret, then press Save and sign in.
Can I use my own ClickUp app?
Yes. In the sheet, open Use your own ClickUp app and paste its Client ID and Client secret. Add the redirect address it shows to your app first. The connection then signs in through your app instead of the installation’s.
Connections says how to sign in again, rename or delete it. In a product that embeds GoRunner, Add connection can be missing: then your provider makes connections for you.
Start a workflow
Add a trigger and choose ClickUp. The trigger uses the same connection as the steps.
On ClickUp Event
Starts a run for each ClickUp event chosen below in the Workspace (or in the one space, folder, list or task picked; the most specific applies). Publishing the workflow registers a ClickUp webhook, whose signing secret is kept encrypted; unpublishing removes it. Every delivery is verified (X-Signature) and an unsigned or wrongly signed one is refused; ClickUp resending the same event starts no second run.
- Workspace · Required
The Workspace to watch.
- Events · Required
Which ClickUp events start the workflow. Any event subscribes to all of them.
Options: Any event to Key result deleted (29 options).
- Space · Optional
Only events in this space.
- Folder · Optional
Only events in this folder.
- List · Optional
Only events in this list.
- Task · Optional
Only events of this task (its id or link).
A later step can use its data, such as {{trigger.event}}, {{trigger.history_items}}, {{trigger.task_id}} and 1 more. See Use data from earlier steps.
Do things in ClickUp
Add a ClickUp step, choose a Resource, then an Operation. Choose a row to see its fields.
- TaskCreate · Get · Get Many · Search Workspace · Update · Delete · Get Members · Set Custom Field · Clear Custom Field
- ListCreate · Get · Get Many · Update · Delete · Get Members · Get Custom Fields
- FolderCreate · Get · Get Many · Update · Delete
- SpaceGet · Get Many
- CommentCreate · Get Many · Update · Delete
- ChecklistCreate · Update · Delete
- Checklist ItemCreate · Update · Delete
- Task TagAdd · Remove
- Space TagCreate · Get Many · Update · Delete
- Task DependencyCreate · Delete
- Task ListAdd · Remove
- Time EntryCreate · Get · Get Many · Update · Delete · Start · Stop
- Time Entry TagAdd · Get Many · Remove
- GoalCreate · Get · Get Many · Update · Delete
- Goal Key ResultCreate · Update · Delete
Later steps read a step’s output by its name: see Use data from earlier steps.
Limits
- A reply from ClickUp can be up to 16 MB (a file download can have its own limit). A larger one fails the step; it is never cut short.
- When ClickUp says to slow down (429), the step waits as long as it asks, if the step’s time allows. Otherwise it fails and says when to try again.
Not in your list? See When an app isn’t here.
For developers
In the API, which calls apps pieces, ClickUp is pieceId: "clickup" with actionId: "clickup", set by resource and an operation_… field, such as operation_checklist. Its trigger is clickuptrigger / clickup_event. Get an app returns every field.
It can change something outside the run (writes_external). See How versions and side effects work.
ClickUp › Task
Create
- Space · Optional
The space to browse lists in, or, for Search Workspace, to search only.
- Folder · Optional
The folder to browse lists in (leave empty for the space's lists outside folders), or, for Search Workspace, to search only.
- List · Required
The list the task goes in, or to read tasks from.
- Name · Optional
The task's name. Required on Create.
- Description · Optional
The task's description as plain text.
- Description (Markdown) · Optional
The description as Markdown; used instead of Description when both are given.
- Status · Optional
A status of the list, such as to do or in progress (as it is named in the list).
- Priority · Optional
Urgent, high, normal or low.
Options: Not set, Urgent, High, Normal, Low.
- Assignees · Optional
User ids, separated by commas. On Get Many and Search, tasks assigned to any of them.
- Tags · Optional
Tag names, separated by commas. On Get Many and Search, tasks with any of them.
- Due Date · Optional
When the task is due.
- Due Date Has a Time · Optional
Yes shows the due date's time of day in ClickUp; No shows the date alone.
Options: Leave as it is, Yes, No.
- Start Date · Optional
When work on the task starts.
- Start Date Has a Time · Optional
Yes shows the start date's time of day in ClickUp.
Options: Leave as it is, Yes, No.
- Time Estimate (minutes) · Optional
How long the task should take, in minutes.
- Sprint Points · Optional
The task's sprint points.
- Parent Task · Optional
Make the task a subtask of this task (its id or link). The parent must be in the same list.
- Notify All · Optional
Notify everyone on the task, the creator included.
Off by default.
- Custom Fields · Optional
Custom field values, such as [{"id": "0a52c486-5f05-403b-b4fd-c512ff05131c", "value": 23}]. List Get Custom Fields shows each field's id and type.
Get
- Task · Required
The task's id or link.
- Include Subtasks · Optional
Also return the task's subtasks.
Off by default.
- Description as Markdown · Optional
Return descriptions as Markdown.
Off by default.
Get Many
- Space · Optional
The space to browse lists in, or, for Search Workspace, to search only.
- Folder · Optional
The folder to browse lists in (leave empty for the space's lists outside folders), or, for Search Workspace, to search only.
- List · Required
The list the task goes in, or to read tasks from.
- Assignees · Optional
User ids, separated by commas. On Get Many and Search, tasks assigned to any of them.
- Tags · Optional
Tag names, separated by commas. On Get Many and Search, tasks with any of them.
- Archived · Optional
On Update: Yes archives the task, No restores it. On Get Many and Search: Yes lists only archived tasks.
Options: Leave as it is, Yes, No.
- Description as Markdown · Optional
Return descriptions as Markdown.
Off by default.
- Statuses · Optional
Only tasks with one of these statuses (names, separated by commas).
- Include Closed · Optional
Also list closed tasks (ClickUp leaves them out by default).
Off by default.
- Include Subtasks · Optional
Also list subtasks (ClickUp leaves them out by default).
Off by default.
- Order By · Optional
How tasks are sorted (newest first).
Options: Date created, Date updated, ID, Due date.
Default: Date created.
- Reverse Order · Optional
Oldest first.
Off by default.
- Due After · Optional
Only tasks due after this date.
- Due Before · Optional
Only tasks due before this date.
- Created After · Optional
Only tasks created after this date.
- Created Before · Optional
Only tasks created before this date.
- Updated After · Optional
Only tasks updated after this date.
- Updated Before · Optional
Only tasks updated before this date.
- Done After · Optional
Only tasks done after this date.
- Done Before · Optional
Only tasks done before this date.
- Custom Field Filters · Optional
Only tasks whose custom fields match, such as [{"field_id": "0a52c486-…", "operator": "=", "value": "1234"}].
- Return All · Optional
Read every task, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tasks to return (1–2000).
Default: 50.
Shows when Return All is off.
Search Workspace
- Workspace · Required
The Workspace to search.
- Space · Optional
The space to browse lists in, or, for Search Workspace, to search only.
- Folder · Optional
The folder to browse lists in (leave empty for the space's lists outside folders), or, for Search Workspace, to search only.
- List · Optional
The list to search only.
- Assignees · Optional
User ids, separated by commas. On Get Many and Search, tasks assigned to any of them.
- Tags · Optional
Tag names, separated by commas. On Get Many and Search, tasks with any of them.
- Archived · Optional
On Update: Yes archives the task, No restores it. On Get Many and Search: Yes lists only archived tasks.
Options: Leave as it is, Yes, No.
- Description as Markdown · Optional
Return descriptions as Markdown.
Off by default.
- Statuses · Optional
Only tasks with one of these statuses (names, separated by commas).
- Include Closed · Optional
Also list closed tasks (ClickUp leaves them out by default).
Off by default.
- Include Subtasks · Optional
Also list subtasks (ClickUp leaves them out by default).
Off by default.
- Order By · Optional
How tasks are sorted (newest first).
Options: Date created, Date updated, ID, Due date.
Default: Date created.
- Reverse Order · Optional
Oldest first.
Off by default.
- Due After · Optional
Only tasks due after this date.
- Due Before · Optional
Only tasks due before this date.
- Created After · Optional
Only tasks created after this date.
- Created Before · Optional
Only tasks created before this date.
- Updated After · Optional
Only tasks updated after this date.
- Updated Before · Optional
Only tasks updated before this date.
- Done After · Optional
Only tasks done after this date.
- Done Before · Optional
Only tasks done before this date.
- Custom Field Filters · Optional
Only tasks whose custom fields match, such as [{"field_id": "0a52c486-…", "operator": "=", "value": "1234"}].
- Return All · Optional
Read every task, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tasks to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Task · Required
The task's id or link.
- Name · Optional
The task's name. Required on Create.
- Description · Optional
The task's description as plain text.
- Description (Markdown) · Optional
The description as Markdown; used instead of Description when both are given.
- Status · Optional
A status of the list, such as to do or in progress (as it is named in the list).
- Priority · Optional
Urgent, high, normal or low.
Options: Not set, Urgent, High, Normal, Low.
- Add Assignees · Optional
User ids to assign, separated by commas.
- Remove Assignees · Optional
User ids to unassign, separated by commas.
- Due Date · Optional
When the task is due.
- Due Date Has a Time · Optional
Yes shows the due date's time of day in ClickUp; No shows the date alone.
Options: Leave as it is, Yes, No.
- Start Date · Optional
When work on the task starts.
- Start Date Has a Time · Optional
Yes shows the start date's time of day in ClickUp.
Options: Leave as it is, Yes, No.
- Time Estimate (minutes) · Optional
How long the task should take, in minutes.
- Sprint Points · Optional
The task's sprint points.
- Parent Task · Optional
Make the task a subtask of this task (its id or link). The parent must be in the same list.
- Archived · Optional
On Update: Yes archives the task, No restores it. On Get Many and Search: Yes lists only archived tasks.
Options: Leave as it is, Yes, No.
Delete and Get Members
- Task · Required
The task's id or link.
Set Custom Field
- Task · Required
The task's id or link.
- Custom Field · Required
The custom field's id (List Get Custom Fields lists them).
- Value · Required
The value to set. Sent as text (a plain number as a number) unless Value Is JSON is on.
- Value Is JSON · Optional
Read the value as JSON (for labels, users, relationships and other non-text fields).
Off by default.
Clear Custom Field
- Task · Required
The task's id or link.
- Custom Field · Required
The custom field's id (List Get Custom Fields lists them).
ClickUp › List
Create
- Outside Folders · Optional
The lists that sit in the space itself, not in a folder.
Off by default.
- Space · Required
The space the list is in.
Shows when Outside Folders is on.
- Folder · Required
The folder the list is in.
Shows when Outside Folders is off.
- Name · Optional
The list's name. Required on Create.
- Description · Optional
The list's description.
- Description (Markdown) · Optional
The description as Markdown; used instead of Description when both are given.
- Due Date · Optional
When the list is due.
- Due Date Has a Time · Optional
Yes shows the due date's time of day in ClickUp.
Options: Leave as it is, Yes, No.
- Priority · Optional
Urgent, high, normal or low.
Options: Not set, Urgent, High, Normal, Low.
- Owner · Optional
The user id of the list's owner.
- Color · Optional
The list's color, such as red (ClickUp calls it the list's status; it is not a task status).
Get, Delete, Get Members and Get Custom Fields
- Space · Optional
The space to browse lists in (only to pick the list).
- List · Required
The list.
Get Many
- Outside Folders · Optional
The lists that sit in the space itself, not in a folder.
Off by default.
- Space · Required
The space the list is in.
Shows when Outside Folders is on.
- Folder · Required
The folder the list is in.
Shows when Outside Folders is off.
- Archived · Optional
List archived lists instead.
Off by default.
Update
- Space · Optional
The space to browse lists in (only to pick the list).
- List · Required
The list.
- Name · Optional
The list's name. Required on Create.
- Description · Optional
The list's description.
- Description (Markdown) · Optional
The description as Markdown; used instead of Description when both are given.
- Due Date · Optional
When the list is due.
- Due Date Has a Time · Optional
Yes shows the due date's time of day in ClickUp.
Options: Leave as it is, Yes, No.
- Priority · Optional
Urgent, high, normal or low.
Options: Not set, Urgent, High, Normal, Low.
- Owner · Optional
The user id of the list's owner.
- Color · Optional
The list's color, such as red (ClickUp calls it the list's status; it is not a task status).
- Remove Color · Optional
Clear the list's color.
Off by default.
ClickUp › Folder
Create
- Space · Required
The space the folder is in.
- Name · Required
The folder's name.
Get and Delete
- Space · Optional
The space to browse folders in (only to pick the folder).
- Folder · Required
The folder.
Get Many
- Space · Required
The space the folder is in.
- Archived · Optional
List archived folders instead.
Off by default.
Update
- Space · Optional
The space to browse folders in (only to pick the folder).
- Folder · Required
The folder.
- Name · Required
The folder's name.
ClickUp › Space
Get
- Space · Required
The space to read.
Get Many
- Workspace · Required
The Workspace whose spaces to list.
- Archived · Optional
List archived spaces instead.
Off by default.
ClickUp › Comment
Create
- Comment On · Optional
Where the comments are: a task, a list, or a chat view.
Options: Task, List, Chat view.
Default: Task.
- Task, List or View · Required
The id of the task (or its link), the list, or the chat view.
- Comment · Optional
The comment's text. Required on Create; on Update it replaces the text.
- Assignee · Optional
Assign the comment to this user (a user id).
- Notify All · Optional
Notify everyone on the task, the comment's author included.
Off by default.
Get Many
- Comment On · Optional
Where the comments are: a task, a list, or a chat view.
Options: Task, List, Chat view.
Default: Task.
- Task, List or View · Required
The id of the task (or its link), the list, or the chat view.
- Return All · Optional
Read every comment, page by page (at most 500; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many comments to return (1–500).
Default: 50.
Shows when Return All is off.
Update
- Comment · Required
The comment's id.
- Comment · Optional
The comment's text. Required on Create; on Update it replaces the text.
- Assignee · Optional
Assign the comment to this user (a user id).
- Resolved · Optional
Yes resolves the comment, No opens it again.
Options: Leave as it is, Yes, No.
Delete
- Comment · Required
The comment's id.
ClickUp › Checklist
Create
- Task · Required
The task to add the checklist to.
- Name · Optional
The checklist's name. Required on Create.
Update
- Checklist · Required
The checklist's id (a task's checklists are in its Get output).
- Name · Optional
The checklist's name. Required on Create.
- Position · Optional
Where the checklist goes among the task's checklists (0 is first).
Delete
- Checklist · Required
The checklist's id (a task's checklists are in its Get output).
ClickUp › Checklist Item
Create
- Checklist · Required
The checklist's id.
- Name · Optional
The item's text. Required on Create.
- Assignee · Optional
Assign the item to this user (a user id).
Update
- Checklist · Required
The checklist's id.
- Checklist Item · Required
The item's id.
- Name · Optional
The item's text. Required on Create.
- Assignee · Optional
Assign the item to this user (a user id).
- Resolved · Optional
Yes ticks the item, No unticks it.
Options: Leave as it is, Yes, No.
- Nest Under · Optional
Nest the item under another item of the checklist (its id).
Delete
- Checklist · Required
The checklist's id.
- Checklist Item · Required
The item's id.
ClickUp › Task Tag
Add and Remove
- Task · Required
The task's id or link.
- Tag · Required
The tag's name, as it is in the task's space.
ClickUp › Space Tag
Create
- Space · Required
The space whose tags to use.
- Tag · Required
The tag's name (on Update and Delete, its current name).
- Text Color · Optional
A hex color, such as #7B68EE.
- Background Color · Optional
A hex color, such as #7B68EE.
Get Many
- Space · Required
The space whose tags to use.
- Return All · Optional
Read every tag, page by page (at most 1000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tags to return (1–1000).
Default: 50.
Shows when Return All is off.
Update
- Space · Required
The space whose tags to use.
- Tag · Required
The tag's name (on Update and Delete, its current name).
- New Name · Optional
Rename the tag.
- Text Color · Optional
A hex color, such as #7B68EE.
- Background Color · Optional
A hex color, such as #7B68EE.
Delete
- Space · Required
The space whose tags to use.
- Tag · Required
The tag's name (on Update and Delete, its current name).
ClickUp › Task Dependency
Create and Delete
- Task · Required
The task that waits.
- Depends On Task · Required
The task it waits on.
ClickUp › Task List
Add and Remove
- Task · Required
The task's id or link.
- List · Required
The list's id or link (not the task's home list).
ClickUp › Time Entry
Create
- Workspace · Required
The Workspace the time is tracked in.
- Start · Optional
When the time began. Required on Create; on Update give the Duration with it.
- Duration (minutes) · Optional
How long, in minutes. Required on Create.
- Task · Optional
The task the time is for (its id or link). On Get Many, only that task's entries.
- Description · Optional
What the time was spent on.
- Billable · Optional
Whether the time is billable.
Options: Leave as it is, Yes, No.
- Tags · Optional
Time entry tag names, separated by commas.
- User · Optional
The user the time is for (a user id; owners and admins may set anyone). On Get Many, only that user's entries.
Get
- Workspace · Required
The Workspace the time is tracked in.
- Running Timer · Optional
Read the timer running now instead of an entry by id.
Off by default.
- Time Entry · Required
The time entry's id.
Shows when Running Timer is off.
Get Many
- Workspace · Required
The Workspace the time is tracked in.
- From · Optional
Entries from this date. Empty with To empty: the last 30 days.
- To · Optional
Entries up to this date.
- Task · Optional
The task the time is for (its id or link). On Get Many, only that task's entries.
- User · Optional
The user the time is for (a user id; owners and admins may set anyone). On Get Many, only that user's entries.
- Include Task Tags · Optional
Add each entry's task tags.
Off by default.
- Include Location Names · Optional
Add the names of each entry's list, folder and space.
Off by default.
- Return All · Optional
Read every time entry, page by page (at most 2000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many time entrys to return (1–2000).
Default: 50.
Shows when Return All is off.
Update
- Workspace · Required
The Workspace the time is tracked in.
- Time Entry · Required
The time entry's id.
- Start · Optional
When the time began. Required on Create; on Update give the Duration with it.
- Duration (minutes) · Optional
How long, in minutes. Required on Create.
- Task · Optional
The task the time is for (its id or link). On Get Many, only that task's entries.
- Description · Optional
What the time was spent on.
- Billable · Optional
Whether the time is billable.
Options: Leave as it is, Yes, No.
- Tags · Optional
Time entry tag names, separated by commas.
- Tags Are · Optional
Whether the Tags replace the entry's tags, are added to them, or are taken off.
Options: The entry's tags, Added, Removed.
Default: The entry's tags.
Delete
- Workspace · Required
The Workspace the time is tracked in.
- Time Entry · Required
The time entry's id.
Start
- Workspace · Required
The Workspace the time is tracked in.
- Task · Optional
The task the time is for (its id or link). On Get Many, only that task's entries.
- Description · Optional
What the time was spent on.
- Billable · Optional
Whether the time is billable.
Options: Leave as it is, Yes, No.
- Tags · Optional
Time entry tag names, separated by commas.
Stop
- Workspace · Required
The Workspace the time is tracked in.
ClickUp › Time Entry Tag
Add
- Workspace · Required
The Workspace of the time entries.
- Time Entries · Required
Time entry ids, separated by commas.
- Tags · Required
Tag names, separated by commas.
- Text Color · Optional
A hex color, such as #7B68EE.
- Background Color · Optional
A hex color, such as #7B68EE.
Get Many
- Workspace · Required
The Workspace of the time entries.
- Return All · Optional
Read every tag, page by page (at most 1000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many tags to return (1–1000).
Default: 50.
Shows when Return All is off.
Remove
- Workspace · Required
The Workspace of the time entries.
- Time Entries · Required
Time entry ids, separated by commas.
- Tags · Required
Tag names, separated by commas.
ClickUp › Goal
Create
- Workspace · Required
The Workspace of the goals.
- Name · Optional
The goal's name. Required on Create.
- Description · Optional
What the goal is about.
- Due Date · Optional
When the goal is due.
- Color · Optional
A hex color, such as #7B68EE.
- Owners · Optional
User ids of the goal's owners, separated by commas.
- Multiple Owners · Optional
Let the goal have more than one owner.
Off by default.
Get and Delete
- Goal · Required
The goal's id.
Get Many
- Workspace · Required
The Workspace of the goals.
- Include Completed · Optional
Also list completed goals.
Off by default.
- Return All · Optional
Read every goal, page by page (at most 1000; past that the step fails rather than stop early).
Off by default.
- Limit · Optional
How many goals to return (1–1000).
Default: 50.
Shows when Return All is off.
Update
- Goal · Required
The goal's id.
- Name · Optional
The goal's name. Required on Create.
- Description · Optional
What the goal is about.
- Due Date · Optional
When the goal is due.
- Color · Optional
A hex color, such as #7B68EE.
- Add Owners · Optional
User ids to add as owners, separated by commas.
- Remove Owners · Optional
User ids to remove as owners, separated by commas.
ClickUp › Goal Key Result
Create
- Goal · Required
The goal to add the key result to.
- Name · Optional
The key result's name. Required on Create.
- Type · Required
How progress is measured.
Options: Number, Currency, True/false, Percentage, Automatic (tasks).
Default: Number.
- Start Value · Optional
The value progress starts from.
- Target Value · Optional
The value that completes the key result.
- Unit · Optional
The unit of the values, such as km or €.
- Owners · Optional
User ids of the key result's owners, separated by commas.
- Tasks · Optional
For an automatic key result: the tasks it tracks (ids, separated by commas).
- Lists · Optional
For an automatic key result: the lists it tracks (ids, separated by commas).
Update
- Key Result · Required
The key result's id.
- Name · Optional
The key result's name. Required on Create.
- Start Value · Optional
The value progress starts from.
- Target Value · Optional
The value that completes the key result.
- Unit · Optional
The unit of the values, such as km or €.
- Current Value · Optional
The progress so far.
- Note · Optional
A note on this progress update.
Delete
- Key Result · Required
The key result's id.