ClickUp v2

Provides integration with ClickUp to query and maintain ClickUp resources through templates based on its published API v2 schema. Use it to synchronize tasks and project data with other applications.

ClickUp is a work management platform for tasks, projects, documents, and collaboration within Workspaces.

Revision History

0.0.0.6 - Initial release.
0.0.0.8 - Updates Runtime compatibility.
0.0.0.12 - Renamed Connection labels, limited TimeoutSeconds to 100 seconds, removed Acquire Metadata, and added per-item route values, CSV lists and Items on Delete.

Connection

Choose personal-token or OAuth authentication.

Property Type Description
Authentication Enum Select PersonalToken (default) or OAuth.
PersonalToken Masked Personal API token beginning with pk_; used in PersonalToken mode.
ClientId String ClickUp app client identifier; used in OAuth mode.
ClientSecret Masked ClickUp app client secret; used in OAuth mode.
AccessToken Masked Token obtained through OAuth account authorization.
TimeoutSeconds Integer Maximum time for one API request. Defaults to 30; must be from 1 to 100.

Setup Notes

  • Run this Node on a Cloud Runtime.
  • Select the authentication mode and enter the corresponding credentials. For OAuth, register the Flowgear callback URL with your ClickUp app and complete account authorization.
  • Run the Connection test before loading operation templates.
  • The connected account needs access to the relevant Workspace and resources.

Methods

Select an operation template under the method matching its HTTP verb.

Query

Retrieves ClickUp resources.

Parameter Type Description
Connection Connection Connection used to authenticate the selected operation.
OperationId String Operation identifier populated by the selected template. Select a template instead of entering this manually.
Options Object Documented path and query values for the selected operation. Paging is handled by the Node.
Return Type Description
Response Array Provider-shaped business rows, one per result, without a Flowgear object. Collection queries with no matches return zero rows.

Create

Creates resources or executes a POST operation.

Parameter Type Description
Connection Connection Connection used to authenticate the selected operation.
OperationId String Operation identifier populated by the selected template. Select a template instead of entering this manually.
Options Object Documented path and query values for the selected operation. Path values apply to items that do not supply their own.
Items Array JSON request-body objects, which can also supply the operation's path values, such as list_id. Supply Items when the operation requires a body; omit Items when no body is documented.
Return Type Description
Response Array Provider response fields with Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request for each processed request.

Update

Updates resources using a PUT operation.

Parameter Type Description
Connection Connection Connection used to authenticate the selected operation.
OperationId String Operation identifier populated by the selected template. Select a template instead of entering this manually.
Options Object Documented path and query values for the selected operation. Path values apply to items that do not supply their own.
Items Array JSON request-body objects, which can also supply the operation's path values, such as task_id. Supply Items when the operation requires a body; omit Items when no body is documented.
Return Type Description
Response Array Provider response fields with Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request for each processed request.

Patch

ClickUp has no PATCH operations, so Patch has no templates. Use Update instead.

Delete

Deletes the resource identified by the selected operation. An operation without a request body runs once from Options when Items is not connected.

Parameter Type Description
Connection Connection Connection used to authenticate the selected operation.
OperationId String Operation identifier populated by the selected template. Select a template instead of entering this manually.
Options Object Documented path and query values for the selected operation. Path values apply to items that do not supply their own.
Items Array Each item names the record to delete, for example task_id. Optional for operations without a request body, and required for Delete Space Tag and Remove tags from time entries, which send a body.
Return Type Description
Response Array Provider response fields with Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request for each processed request.

Usage Notes

  • Query errors fail the Step.
  • A failed Create, Update or Delete item returns Flowgear.IsSuccess set to false with ClickUp's message in Flowgear.Message, and later items still run. A rate limit that remains after retries, a timeout, an unreachable host, or a rejected token (OAUTH_025) on the first request fails the Step instead, and earlier items are already saved. Any other 401, including a rejected token on a later request, fails only that item.
  • ClickUp issues no refresh token. When ClickUp rejects the OAuth token, reconnect the account on the Connection.
  • ClickUp answers a record that does not exist or is not shared with the token's user with HTTP 401 OAUTH_027 ("Team not authorized") instead of 404. Check the ID and the user's access to the record.
  • The Node returns every page as one row per result, so do not set page, start or start_id in Options.
  • String, integer and number lists use comma-separated values (CSV), for example to do,in progress for statuses[]. Enclose values containing commas, quotes or line breaks in double quotes, and double any quotes inside a value. Empty text represents an empty list.
  • Enter the custom_fields and custom_field task filters as JSON filter expression text.
  • Each item can carry its own route values, such as task_id or list_id; Options values apply to items that do not. Enter IDs as text to keep long IDs intact.
  • A null item field is not sent, so you cannot clear a ClickUp field by sending null.
  • Workflows built on version 0.0.0.8 must map Response fields directly instead of wrappers such as Response.tasks or Response.user, and use the [] filter names, such as statuses[].

Known Issues

  • Multipart attachment operations are not exposed.
  • Operation availability depends on the published schema, ClickUp plan, and Workspace permissions.
  • Some ClickUp schemas declare objects without fields, such as view divide settings and custom field type_config and value, so their templates show these without child fields.
  • Get Bulk Tasks' Time in Status returns one empty row when Time in Status is not on your ClickUp plan or the tasks have no data. Other Time in Status queries fail with TIS_027 ("Time In Status is not available on your plan.") when the feature is not on your plan.
  • Delete Dependency requires both depends_on and dependency_of, because ClickUp's API document marks both as required.