ClickUp

Parámetros de entrada

• task_idstringObligatorio

  Unique identifier of the task to which a dependency relationship will be added.

• team_idinteger

  Team ID, required if `custom_task_ids` is true to look up tasks by custom IDs (unique per team).

• depends_onstring

  ID of the task that `task_id` will depend on ('waiting on' relationship). Use this or `dependency_of`, not both.

• depedency_ofstring

  ID of the task that will depend on `task_id` ('blocking' relationship). Use this or `depends_on`, not both.

• custom_task_idsboolean

  If true, `task_id` and related task IDs are custom (text-based), requiring `team_id`.

Parámetros de salida

• dataobjectObligatorio

  Confirms successful dependency creation, often an empty object `{}` on success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• guest_idintegerObligatorio

  The unique identifier of the guest user to be added to the folder.

• folder_idintegerObligatorio

  The unique identifier of the folder to which the guest will be added.

• include_sharedboolean

  If `true`, include shared item details (API default if parameter is omitted); if `false`, exclude them.

• permission_levelstringObligatorio

  Permission level for the guest. Options are 'read' (view only), 'comment', 'edit', or 'create' (full access).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the API, typically confirming the successful addition of the guest to the folder and providing details of the shared folder and guest.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The unique numerical identifier of the List to which the guest will be added.

• guest_idintegerObligatorio

  The unique numerical identifier of the guest user to be added to the List.

• include_sharedboolean

  A boolean indicating whether to include details of items shared with the guest in the response. Set to `false` to exclude these details. If not provided or set to `true` (the API default), shared item details are included.

• permission_levelstringObligatorio

  The permission level to be granted to the guest on this List. Accepted values are: `read` (view-only), `comment` (can add comments), `edit` (can edit existing items), or `create` (full access, including creating new items).

Parámetros de salida

• dataobjectObligatorio

  Confirmation response after adding the guest, typically including list details and the guest's new permissions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task to which the guest will be added.

• team_idinteger

  Required if `custom_task_ids` is `true` to correctly identify the task when using a custom task ID.

• guest_idintegerObligatorio

  The unique identifier of the guest user to be added to the task.

• include_sharedboolean

  Optional. If set to `false`, details of items already shared with the guest will be excluded. The API defaults to `true` if this parameter is not explicitly set to `false`.

• custom_task_idsboolean

  Optional. Set to `true` if you are referencing the task by its custom task ID. If `true`, `team_id` must also be provided.

• permission_levelstringObligatorio

  Permission level for the guest on this task. Must be one of: `read` (view only), `comment` (view and comment), `edit` (view, comment, and edit), or `create` (full permissions).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tagsobject[]Obligatorio

  A list of tag objects to add to the time entries. Each object should define the tag, typically including a 'name', and optionally 'tag_fg' (foreground color hex code) and 'tag_bg' (background color hex code).

• team_idintegerObligatorio

  The ID of the Team (Workspace) where the time entries are located.

• time_entry_idsstring[]Obligatorio

  A list of unique string identifiers for the time entries to which the tags will be added.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the ClickUp API, typically indicating the success or status of the tag addition operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the task to which the tag will be added. This can be the standard task ID or a custom task ID if `custom_task_ids` is set to `true`.

• team_idinteger

  The ID of the team (formerly Workspace) to which the task belongs. This is required only if `custom_task_ids` is set to `true`. For example: `custom_task_ids=true&team_id=123`.

• tag_namestringObligatorio

  The name of the tag to add to the task. The tag must already exist in the workspace.

• custom_task_idsboolean

  A boolean flag indicating whether the `task_id` provided is a custom task ID. If `true`, the `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the source task.

• team_idinteger

  The ID of the team, used when `custom_task_ids` is true to identify tasks by custom IDs. For example: `custom_task_ids=true&team_id=123`.

• links_tostringObligatorio

  The ID of the target task.

• custom_task_idsboolean

  Set to `true` to indicate that `task_id` and `links_to` are custom task IDs rather than standard numerical IDs. If `true`, `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  Response data, typically confirming the task link.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  Unique identifier of the List to which the task will be added.

• task_idstringObligatorio

  Unique identifier of the task to add to the List (actual task ID, not Custom Task ID).

Parámetros de salida

• dataobjectObligatorio

  API response confirming task addition; structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task to which the attachment will be added.

• team_idinteger

  The ID of the team. This is required and used only if `custom_task_ids` is `true` to help locate the task by its custom ID. For example: `custom_task_ids=true&team_id=123`.

• attachmentarray

  The file to be uploaded, sent as part of a `multipart/form-data` request. This field should contain the raw file data.

• custom_task_idsboolean

  If `true`, indicates that `task_id` should be interpreted as a custom task ID instead of the default ClickUp task ID. If this is `true`, `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  Authorization code from ClickUp's authorization server, typically a query parameter to your redirect URI after user consent.

• client_idstringObligatorio

  Client ID for your registered ClickUp OAuth application.

• client_secretstringObligatorio

  Client Secret for your registered ClickUp OAuth application.

Parámetros de salida

• dataobjectObligatorio

  Contains the `access_token` and other token-related details (e.g., token type, expiry time); `access_token` is the primary field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Contains a list of authorized Workspaces (Teams), where each Workspace object includes details like 'id', 'name', 'color', and 'avatar'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The current name of the time entry tag to be modified.

• tag_bgstringObligatorio

  The new background color for the tag, specified as a hexadecimal color code.

• tag_fgstringObligatorio

  The new foreground (text) color for the tag, specified as a hexadecimal color code.

• team_idintegerObligatorio

  The unique identifier of the Team (Workspace) where the time entry tag exists.

• new_namestringObligatorio

  The new name to be assigned to the time entry tag.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary confirming the successful renaming and/or recoloring of the tag.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• endinteger

  Alias for `stop`. The end time of the time entry, as a Unix timestamp in milliseconds. If both `start` and `end` are provided, the API will use these to determine the entry's actual duration, potentially overriding the `duration` field sent in the request.

• tidstring

  The ID of the task to associate this time entry with. If `custom_task_ids` is `true`, this should be the custom task ID.

• stopinteger

  The stop time of the time entry, as a Unix timestamp in milliseconds. If both `start` and `stop` are provided, the API will use these to determine the entry's actual duration, potentially overriding the `duration` field sent in the request.

• tagsobject[]

  An array of Tag objects to apply to the time entry. Each Tag object should define 'name' (string), 'tag_fg' (hex color string for foreground), and 'tag_bg' (hex color string for background). This feature is available for users on the ClickUp Business Plan and above.

• startintegerObligatorio

  The start time of the time entry, as a Unix timestamp in milliseconds.

• team_IdintegerObligatorio

  The ID of the Team (Workspace) to which the time entry will be added.

• team_idinteger

  The ID of the Team, required only if `custom_task_ids` is set to `true`. This specifies the team context for the custom task ID. Example: `custom_task_ids=true&team_id=123`.

• assigneeinteger

  The user ID of the person to assign this time entry to. Workspace owners and admins can assign to any user ID. Workspace members can only assign to their own user ID.

• billableboolean

  Indicates whether the time entry is billable. Set to `true` if billable, `false` or omit if not.

• durationintegerObligatorio

  The duration of the time entry in milliseconds. Note: If `start` and `end` (or `stop`) times are also provided in the request, the ClickUp API will calculate the duration based on `start` and `end`/`stop`, and this `duration` field's value might be ignored or overridden by the server.

• descriptionstring

  An optional description for the time entry.

• custom_task_idsboolean

  If `true`, the `tid` parameter will be interpreted as a custom task ID. If this is `true`, the `team_id` query parameter must also be provided to specify the team context for the custom task ID.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the created time entry.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• view_idstringObligatorio

  The unique identifier of the Chat view where the comment will be posted.

• notify_allbooleanObligatorio

  If `True`, notifications for this comment will be sent to all members of the Chat view, including the comment creator. If `False`, notifications will follow standard ClickUp behavior.

• comment_textstringObligatorio

  The text content of the comment to be added.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new checklist.

• task_idstringObligatorio

  Unique identifier of the task for the new checklist; can be a standard or custom task ID (if `custom_task_ids` is true).

• team_idinteger

  Team's unique identifier; required only if `custom_task_ids` is true.

• custom_task_idsboolean

  If true, `task_id` is treated as a custom task ID, requiring `team_id`.

Parámetros de salida

• dataobjectObligatorio

  Dictionary representing the created checklist, including its ID and other attributes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  Name for the new checklist item. If not provided, the item might be created with a default or empty name.

• assigneeinteger

  User ID of the ClickUp user to whom this item will be assigned. If omitted, the item will be unassigned.

• checklist_idstringObligatorio

  UUID of the parent checklist where the new item will be created; this checklist must already exist.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created checklist item, typically including its ID, name, task ID, resolved status, and assignee information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the Folder to be created.

• space_idintegerObligatorio

  Numerical ID of the Space in which to create the Folder.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new folderless list.

• statusstring

  List color (e.g., 'red', 'blue_blended'), distinct from task statuses within the list. Null for no color.

• contentstring

  Description for the list (plain text or markdown).

• assigneeinteger

  `user_id` of the list owner. Null for no specific owner.

• due_dateinteger

  Due date for the list (POSIX timestamp in milliseconds).

• priorityinteger

  Priority level: `1` (Urgent), `2` (High), `3` (Normal), `4` (Low). Null to remove priority.

• space_idintegerObligatorio

  Identifier of the Space for the new folderless list.

• due_date_timeboolean

  Indicates if `due_date` includes time (`true`) or is all-day (`false`). Required if `due_date` is set.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new view.

• typestringObligatorio

  The type of view to create. Options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.

• folder_idintegerObligatorio

  Numeric ID of the folder where the new view will be created.

• divide__dirnull

  This field must be `null` (None). It is intended for specifying sort direction within divided sections, but its configuration is not fully detailed.

• filters__opstring

  Operator for combining filters. The available operator (`op`) values are `AND` and `OR`.

• divide__fieldnull

  This field must be `null` (None). It is intended for view division features (e.g., swimlanes) whose specific configuration via this parameter is not fully detailed.

• grouping__dirinteger

  Set a group sort order. Use `1` for ascending (e.g., urgent priority at top of the view, and tasks with no priority at the bottom) or `-1` to reverse the order (e.g., tasks with no priority at the top).

• columns__fieldsstring[]

  Array of field names to display as columns in the view. Custom Fields require the `_cf` prefix followed by the Custom Field ID (e.g., `_cf_xxxxxxxx`).

• filters__fieldsstring[]

  Fields to filter by. Each element represents a filter condition. View the list of available fields in ClickUp's API documentation.

• filters__searchstring

  Text string to search for within tasks, comments, and subtasks in the view.

• grouping__fieldstring

  Field to group tasks by. Options include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`.

• sorting__fieldsstring[]

  Fields to sort tasks by. Elements can be a field name or a JSON string for custom fields. You can sort by the same fields available when filtering a view.

• grouping__ignoreboolean

  If `true`, tasks with no value for the `grouping__field` will not be grouped and will appear in a separate 'Ungrouped' section.

• divide__collapsedboolean

  If `true`, and if the view type supports division and is configured with `divide__field`, divided sections will be collapsed by default.

• grouping__collapsedstring[]

  An array of group identifiers (e.g., status names like 'Open', assignee IDs as strings like '123') that should be initially collapsed in the view. These identifiers depend on the `grouping__field` used.

• filters__show__closedboolean

  If `true`, tasks with a closed status are included in the view.

• settings__me__commentsboolean

  In 'Me Mode', if `true`, show only comments where the current user is mentioned or assigned.

• settings__me__subtasksboolean

  In 'Me Mode', if `true`, show only subtasks assigned to the current user.

• settings__show__imagesboolean

  If `true`, display task cover images or image attachments.

• settings__me__checklistsboolean

  In 'Me Mode', if `true`, show only checklists assigned to the current user.

• settings__show__subtasksinteger

  Controls subtask visibility. Acceptable integer values are `1` (show subtasks as separate tasks), `2` (expand subtasks under parent tasks), or `3` (collapse subtasks under parent tasks).

• team__sidebar__assigneesstring[]

  List of user IDs (as strings). Tasks assigned to these users will appear in the 'Assignees' section of the team sidebar.

• settings__show__assigneesboolean

  If `true`, display task assignees.

• settings__show__task__locationsboolean

  If `true`, display the List, Folder, and Space location for tasks.

• settings__show__closed__subtasksboolean

  If `true`, include closed subtasks in the view.

• team__sidebar__unassigned__tasksboolean

  If `true`, unassigned tasks will be shown in the team sidebar.

• team__sidebar__assigned__commentsboolean

  If `true`, comments assigned to users will be shown in the team sidebar.

• settings__collapse__empty__columnsstring

  Specifies whether to collapse columns with no tasks (e.g., in Board view). Common string values are 'true' or 'false'.

• settings__show__subtask__parent__namesboolean

  If `true`, display parent task names for subtasks.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the goal.

• colorstringObligatorio

  Hex color string to associate with the goal.

• ownersinteger[]Obligatorio

  List of user IDs to be assigned as owners of the goal.

• team_idintegerObligatorio

  Numeric ID of the ClickUp Team (Workspace) where the goal will be created.

• due_dateintegerObligatorio

  Due date for the goal, as a Unix timestamp in milliseconds.

• descriptionstringObligatorio

  Detailed description for the goal.

• multiple_ownersbooleanObligatorio

  Set to `true` if the goal will have multiple owners; `false` for a single owner.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name for the new Key Result.

• typestringObligatorio

  Specifies the type of the Key Result, which determines how progress is tracked. Supported types: 'number', 'currency', 'boolean', 'percentage', 'automatic'.

• unitstringObligatorio

  The unit of measurement for Key Results of type 'number', 'currency', or 'percentage' (e.g., '$', '%', 'items'). This may not be applicable for 'boolean' or 'automatic' types where progress is count-based.

• ownersinteger[]Obligatorio

  A list of numerical user IDs to be assigned as owners of this Key Result.

• goal_idstringObligatorio

  The unique identifier (UUID) of the parent Goal for which this Key Result is being created.

• list_idsstring[]Obligatorio

  An array of List UUIDs to link to this Key Result. Can be used with 'automatic' type Key Results to track progress based on tasks within these lists.

• task_idsstring[]Obligatorio

  An array of task UUIDs to link to this Key Result. Often used when `type` is 'automatic' to track progress via the completion status of these linked tasks.

• steps_endintegerObligatorio

  The target value indicating Key Result completion. For 'boolean' type, use 1 for true/complete. For 'automatic' type, this is often the total count of items to complete (e.g., number of linked tasks).

• steps_startintegerObligatorio

  The initial value for tracking Key Result progress. For 'boolean' type, use 0 for false/incomplete, 1 for true/complete. For 'automatic' type, this is often the initial count (e.g., 0).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full data of the newly created Key Result.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name to be assigned to the new list.

• statusstring

  Optional. Defines the list's color in the ClickUp UI (e.g., 'red', 'blue'). **Important:** This 'status' refers to the visual color of the list itself, not the workflow statuses (like 'To Do', 'In Progress') of tasks within the list.

• contentstring

  Optional descriptive content or notes for the list.

• assigneeinteger

  Optional. Numerical user ID of the assignee.

• due_dateinteger

  Optional due date for the list, represented as a POSIX timestamp in milliseconds. For example, `1695110307000` for September 19, 2023, 07:58:27 AM GMT.

• priorityinteger

  Optional priority level for the list. Integer values map to: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).

• folder_idintegerObligatorio

  The unique numerical identifier of the folder where the new list will be created.

• due_date_timeboolean

  Optional. A boolean flag indicating whether the `due_date` includes a specific time. If `True`, the time component of `due_date` is respected. If `False` or not provided, the list is considered due on the entire day specified by `due_date`.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full details of the newly created list.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The numerical ID of the ClickUp List where the comment will be posted.

• assigneeintegerObligatorio

  The User ID of the ClickUp user to whom this comment should be assigned, turning it into an actionable item.

• notify_allbooleanObligatorio

  If `true`, notifications about this comment will be sent to all members of the list, including the comment's creator. If `false` or omitted, default notification rules (e.g., based on mentions or assignments) will apply.

• comment_textstringObligatorio

  The textual content of the comment to be posted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing details of the successfully created comment, typically including its ID, text, creation date, and the user who posted it.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new view.

• typestringObligatorio

  View type (e.g., `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, `gantt`).

• list_idintegerObligatorio

  Numeric ID of the List where the new view will be created.

• divide__dirnull

  Direction for secondary grouping (`1` for ascending, `-1` for descending). Type is `None`; consult API documentation for usage.

• filters__opstring

  Logical operator for combining filters: `AND` for all conditions, `OR` for any condition.

• divide__fieldnull

  Field for secondary grouping (dividing tasks within primary groups). Type is `None`; consult API documentation for usage.

• grouping__dirinteger

  Group sort order: `1` for ascending (e.g., urgent priority top), `-1` for descending (e.g., no priority top).

• columns__fieldsstring[]

  List of field names for columns. Use `_cf_FIELD_ID` for Custom Fields. Refer to ClickUp API for complex JSON format with Custom Fields.

• filters__fieldsstring[]

  List of field conditions for filtering tasks. Refer to ClickUp API for available fields and syntax.

• filters__searchstring

  Search string to filter tasks by name or content.

• grouping__fieldstring

  Field for grouping tasks (e.g., `none`, `status`, `priority`, `assignee`, `tag`, `dueDate`).

• sorting__fieldsstring[]

  Array of field names for task sorting (e.g., 'dueDate asc'). Refer to ClickUp API for available fields and syntax.

• grouping__ignoreboolean

  If `true`, hides tasks not falling into any specified group.

• divide__collapsedboolean

  If `true`, collapses divided sections (secondary groups) by default if view division is active.

• grouping__collapsedstring[]

  List of group identifiers (e.g., status names, assignee IDs) to collapse by default.

• filters__show__closedboolean

  If `true`, includes closed tasks in the view.

• settings__me__commentsboolean

  If `true`, enables 'Me Mode' for comments, filtering to tasks where the current user is involved in comments.

• settings__me__subtasksboolean

  If `true`, enables 'Me Mode' for subtasks, filtering to subtasks assigned to the current user.

• settings__show__imagesboolean

  If `true`, displays cover images or image attachments for tasks.

• settings__me__checklistsboolean

  If `true`, enables 'Me Mode' for checklists, filtering to tasks with checklists assigned to the current user.

• settings__show__subtasksinteger

  Subtask visibility: `1` (separate tasks), `2` (expanded under parent), `3` (collapsed under parent).

• team__sidebar__assigneesstring[]

  List of user IDs for quick assignee filtering in the team sidebar.

• settings__show__assigneesboolean

  If `true`, shows assignees' avatars or names on tasks.

• settings__show__task__locationsboolean

  If `true`, displays task's location (e.g., List, Folder, Space) in the view.

• settings__show__closed__subtasksboolean

  If `true`, displays closed subtasks in the view.

• team__sidebar__unassigned__tasksboolean

  If `true`, team sidebar includes filter for unassigned tasks.

• team__sidebar__assigned__commentsboolean

  If `true`, team sidebar includes filter for tasks with assigned comments.

• settings__collapse__empty__columnsstring

  Controls collapsing of empty columns. Values like 'true', 'false', or specific keywords (see ClickUp API).

• settings__show__subtask__parent__namesboolean

  If `true`, displays parent task names alongside subtasks.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Desired name for the new space.

• colorstring

  Hexadecimal color code for the space (e.g., '#FF0000').

• privateboolean

  Whether the space should be private (accessible only to invited members).

• team_idstringObligatorio

  Unique identifier of the team (workspace) in which to create the space.

• featuresobject

  Detailed configuration for features to be enabled or customized for the space.

• multiple_assigneesboolean

  Whether tasks in this space can have multiple assignees.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Numeric ID of the Space to create the tag in.

• tag__namestring

  Name for the new tag.

• tag__tag__bgstring

  Hexadecimal background color for the tag.

• tag__tag__fgstring

  Hexadecimal foreground (text) color for the tag.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name for the new view.

• typestringObligatorio

  The type of view to create. Valid options include: `list`, `board`, `calendar`, `table`, `timeline`, `workload`, `activity`, `map`, `conversation`, or `gantt`.

• space_idintegerObligatorio

  The unique identifier of the Space where the new view will be created.

• divide__dirnull

  Sort order for divided sections. Must be `None` if included, as sort direction for divisions may not be applicable here.

• filters__opstring

  Logical operator (`AND` or `OR`) for combining filters. Required if multiple `filters__fields` are specified.

• divide__fieldnull

  Field to divide tasks by. Must be `None` if included, as division by field may not be applicable for Space views via this action.

• grouping__dirinteger

  Group sort order: `1` for ascending, `-1` for descending. Required if `grouping__field` is set and not 'none'.

• columns__fieldsstring[]

  Field identifiers for columns. Use standard field names (e.g., 'status') or Custom Field IDs with `_cf` prefix (e.g., 'ID_cf').

• filters__fieldsstring[]

  Fields to apply filters on. Refer to ClickUp API documentation for available filterable fields and their syntax.

• filters__searchstring

  A search string to filter tasks by keywords or specific criteria within the view.

• grouping__fieldstring

  The field to group tasks by. Options include: `none`, `status`, `priority`, `assignee`, `tag`, or `dueDate`.

• sorting__fieldsstring[]

  Fields to sort tasks by (e.g., `dueDate`, `priority`). Refer to ClickUp API documentation for a complete list of sortable fields.

• grouping__ignoreboolean

  If `True`, tasks not matching grouping criteria are hidden; otherwise, they are shown in a default group.

• divide__collapsedboolean

  If `True`, divided sections are collapsed by default. Required if division is configured.

• grouping__collapsedstring[]

  A list of string identifiers for groups that should be collapsed by default (e.g., status names like 'Closed', or assignee user IDs if grouping by assignee).

• filters__show__closedboolean

  If `True`, closed tasks are included in the view.

• settings__me__commentsboolean

  If `True`, in 'Me Mode', this setting filters for or highlights tasks where the current user has made comments.

• settings__me__subtasksboolean

  If `True`, in 'Me Mode', this setting filters for or highlights subtasks assigned to the current user.

• settings__show__imagesboolean

  If `True`, displays cover images or image attachments directly on task cards in the view.

• settings__me__checklistsboolean

  If `True`, in 'Me Mode', this setting filters for or highlights tasks with checklist items assigned to the current user.

• settings__show__subtasksinteger

  How subtasks are displayed: `1` (show as separate tasks), `2` (show expanded under parent task), or `3` (show collapsed under parent task).

• team__sidebar__assigneesstring[]

  A list of user IDs (as strings) to filter by in the team sidebar.

• settings__show__assigneesboolean

  If `True`, displays task assignees in the view (e.g., on task cards).

• settings__show__task__locationsboolean

  If `True`, displays the task's location (List, Folder, Space).

• settings__show__closed__subtasksboolean

  If `True`, includes closed subtasks in the view according to other filter criteria.

• team__sidebar__unassigned__tasksboolean

  If `True`, shows unassigned tasks in the team sidebar.

• team__sidebar__assigned__commentsboolean

  If `True`, shows tasks with comments assigned to the current user in the team sidebar.

• settings__collapse__empty__columnsstring

  If 'true', collapses empty columns (e.g., status columns with no tasks). Use string 'true' or 'false'.

• settings__show__subtask__parent__namesboolean

  If `True`, displays the parent task name next to subtasks for clarity.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full details of the newly created Space view object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the new task.

• tagsstring[]

  Tag names to apply.

• parentstring

  ID of an existing task to be the parent (creating a subtask). Parent must not be a subtask and must be in the same list.

• statusstring

  Status to set for the task.

• list_idintegerObligatorio

  The ID of the list where the task will be created.

• team_idinteger

  Team ID, required only if `custom_task_ids` is `true`.

• due_dateinteger

  Due date as a Unix timestamp in milliseconds.

• links_tostring

  ID of an existing task to link as a dependency.

• priorityinteger

  Priority level: 1 (Urgent), 2 (High), 3 (Normal), 4 (Low).

• assigneesinteger[]

  User IDs to assign to the task.

• notify_allboolean

  `True` to send notifications to all task watchers, including the creator.

• start_dateinteger

  Start date as a Unix timestamp in milliseconds.

• descriptionstring

  Task's detailed description.

• custom_fieldsobject[]

  Custom fields to apply. See ClickUp API for structure.

• due_date_timeboolean

  `True` if `due_date` includes a specific time, `false` if it's an all-day task.

• time_estimateinteger

  Estimated time to complete, in milliseconds.

• custom_item_idinteger

  Custom task type ID. Omit or use `null` for standard task, `1` for Milestone, or Workspace-defined ID for others.

• custom_task_idsboolean

  Enables referencing tasks by custom task ID; requires `team_id` if `true`.

• start_date_timeboolean

  `True` if `start_date` includes a specific time, `false` if it's an all-day task.

• check_required_custom_fieldsboolean

  `True` to enforce filling all required Custom Fields upon creation.

Parámetros de salida

• dataobjectObligatorio

  Full details of the newly created task.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task to which the attachment will be added.

• team_idinteger

  The ID of the team. This is required and used only if `custom_task_ids` is `true` to help locate the task by its custom ID. For example: `custom_task_ids=true&team_id=123`.

• attachmentarray

  The file to be uploaded, sent as part of a `multipart/form-data` request. This field should contain the raw file data.

• custom_task_idsboolean

  If `true`, indicates that `task_id` should be interpreted as a custom task ID instead of the default ClickUp task ID. If this is `true`, `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Unique task identifier for the comment. Can be standard or custom if `custom_task_ids` is true.

• team_idinteger

  Team ID, required if `custom_task_ids` is true to locate the task by its custom ID.

• assigneeintegerObligatorio

  The user ID of the person to whom this specific comment should be assigned or mentioned. This assigns the comment, not the task.

• notify_allbooleanObligatorio

  If `true`, notifications for this comment will be sent to all users watching the task, including the comment's creator. If `false`, notifications will be sent according to standard ClickUp notification rules (e.g., to mentioned users, comment assignee).

• comment_textstringObligatorio

  The text content for the comment. Supports ClickUp's comment formatting (e.g., mentions, markdown).

• custom_task_idsboolean

  Set to `true` to indicate that the `task_id` provided is a custom task ID. If `true`, the `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data from the API, typically including the ID of the created comment, its content, and other relevant details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new task created from the template.

• list_idintegerObligatorio

  Numeric ID of the ClickUp list for task creation, found in the list's URL.

• template_idstringObligatorio

  Unique string ID of the task template to use.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created task.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new team (user group).

• membersinteger[]Obligatorio

  User IDs to be initial members of the new team (user group).

• team_idintegerObligatorio

  Workspace ID where the team (user group) will be created (this is referred to as 'Team ID' in the ClickUp API).

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created team (user group).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• eventsstring[]Obligatorio

  Event types to subscribe to; use '*' for all events on the resource. Examples: 'taskCreated', 'taskUpdated'.

• list_idinteger

  Optional. ID of the List to scope the webhook; triggers only for events in this List.

• task_idstring

  Optional. ID of the Task to scope the webhook; triggers only for events for this Task.

• team_idintegerObligatorio

  ID of the Team (Workspace) for the webhook.

• endpointstringObligatorio

  Publicly accessible URL for ClickUp to send POST notifications for subscribed events.

• space_idinteger

  Optional. ID of the Space to scope the webhook; triggers only for events in this Space.

• folder_idinteger

  Optional. ID of the Folder to scope the webhook; triggers only for events in this Folder.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. Typically includes the 'id' of the created webhook and a 'webhook' object detailing its configuration (endpoint, events, resource scope), health status, and secret.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new view.

• typestringObligatorio

  Type of view to create (e.g., list, board, calendar).

• team_idintegerObligatorio

  Team (Workspace) ID where the 'Everything' level view will be created.

• divide__dirnull

  Sort direction for divided sections: `1` for ascending, `-1` for descending.

• filters__opstring

  Logical operator for combining filters (`AND` or `OR`).

• divide__fieldnull

  Field to divide the view by, creating separate sections (e.g., 'priority', 'status').

• grouping__dirinteger

  Sort order for grouped tasks: `1` for ascending, `-1` for descending.

• columns__fieldsstring[]

  Columns to display and their order. Prefix Custom Fields with `_cf`. For specific configurations, use a JSON object string.

• filters__fieldsstring[]

  Fields to apply filters on. See ClickUp API docs for filterable fields.

• filters__searchstring

  Search term to filter tasks by name, description, etc.

• grouping__fieldstring

  Field to group tasks by (e.g., status, priority).

• sorting__fieldsstring[]

  Fields to sort tasks by. See ClickUp API docs for sortable fields.

• grouping__ignoreboolean

  If true, tasks in closed statuses are excluded from grouping.

• divide__collapsedboolean

  If true, divided sections are collapsed by default.

• grouping__collapsedstring[]

  List of group identifiers (e.g., status names, assignee IDs) to be collapsed by default.

• filters__show__closedboolean

  If true, include tasks with 'Closed' status in the view.

• settings__me__commentsboolean

  If true, 'Me Mode' filters for tasks commented on by the current user.

• settings__me__subtasksboolean

  If true, 'Me Mode' filters for subtasks assigned to the current user.

• settings__show__imagesboolean

  If true, show task cover images or attachment previews.

• settings__me__checklistsboolean

  If true, 'Me Mode' filters for tasks where current user is assigned to checklist items.

• settings__show__subtasksinteger

  Subtask display mode: `1` (separate), `2` (expand), `3` (collapse).

• team__sidebar__assigneesstring[]

  List of user IDs to filter tasks by in the team sidebar.

• settings__show__assigneesboolean

  If true, display task assignees.

• settings__show__task__locationsboolean

  If true, display breadcrumb path (Space > Folder > List) for each task.

• settings__show__closed__subtasksboolean

  If true, show closed subtasks according to `settings_show_subtasks`.

• team__sidebar__unassigned__tasksboolean

  If true, team sidebar includes filter for unassigned tasks.

• team__sidebar__assigned__commentsboolean

  If true, team sidebar includes filter for tasks with assigned comments.

• settings__collapse__empty__columnsstring

  If true, collapse or hide empty columns.

• settings__show__subtask__parent__namesboolean

  If true, display parent task name next to subtasks.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created view, including ID and configuration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique identifier of the Workspace from which the time entry will be deleted.

• timer_idintegerObligatorio

  Unique identifier of the time entry to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Response data from the API. For a successful deletion, this may be an empty object or a confirmation message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• checklist_idstringObligatorio

  The unique identifier (UUID) of the checklist to be deleted.

Parámetros de salida

• dataobjectObligatorio

  An empty object is typically returned upon successful deletion of the checklist.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• checklist_idstringObligatorio

  Unique identifier (UUID) of the checklist containing the item to be deleted.

• checklist_item_idstringObligatorio

  Unique identifier (UUID) of the specific checklist item to be deleted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• comment_idintegerObligatorio

  The unique identifier of the comment to be deleted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Identifier of the primary task whose dependency relationships with `depends_on` and `dependency_of` tasks will be removed.

• team_idinteger

  Numeric team ID, required only when `custom_task_ids` is true to scope custom task IDs.

• depends_onstringObligatorio

  Identifier of the task that `task_id` depends on (i.e., `task_id` is blocked by this task).

• dependency_ofstringObligatorio

  Identifier of the task that depends on `task_id` (i.e., this task is blocked by `task_id`).

• custom_task_idsboolean

  If true, interprets `task_id`, `depends_on`, and `dependency_of` as custom task IDs; `team_id` also required.

Parámetros de salida

• dataobjectObligatorio

  API response; typically an empty object `{}` on successful deletion of a dependency.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• folder_idintegerObligatorio

  The unique numerical identifier of the folder to be deleted.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary upon successful deletion, or error details if deletion fails.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• goal_idstringObligatorio

  The unique identifier (UUID) of the Goal to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Response data from the API. Typically an empty object on successful deletion.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• key_result_idstringObligatorio

  The unique identifier (UUID) of the Key Result to be deleted. This is often referred to as a 'Target' in the context of Goals.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response data. Typically, this will be an empty object for a successful deletion (indicating an HTTP 204 No Content response).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The unique numerical identifier of the List to be deleted. This ID can be found by navigating to the List in ClickUp; the ID is often present in the URL.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the ClickUp API. Typically, this will be an empty object on successful deletion, confirming the List has been removed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Unique numerical ID of the Space to be deleted.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary indicating successful deletion of the Space.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Numeric identifier of the Space from which the Tag will be deleted.

• tag_namestringObligatorio

  Name of the Tag to be deleted, used in the URL path to identify it.

• tag__namestring

  Name of the Tag in the request body. Though schema-optional, generally required by the API to match the Tag's actual name for successful deletion.

• tag__tag__bgstring

  Background color of the Tag in HEX format (e.g., '#FF5733') in the request body. Though schema-optional, generally required by the API for successful deletion.

• tag__tag__fgstring

  Foreground (text) color of the Tag in HEX format (e.g., '#FFFFFF') in the request body. Though schema-optional, generally required by the API for successful deletion.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. For a successful deletion, this is typically an empty object or a minimal success confirmation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Unique ID of the task to delete. Can be a standard ID or a custom task ID (if custom, `custom_task_ids` must be `true`).

• team_idinteger

  Team ID. Required only if `custom_task_ids` is `true` to identify the team for the custom task ID.

• custom_task_idsboolean

  Set to `true` if `task_id` is a custom ID (requires `team_id` if `true`).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the first task involved in the link. If `custom_task_ids` is `true`, this should be its custom task ID.

• team_idinteger

  The numerical ID of the team. This parameter is required and used only when `custom_task_ids` is set to `true` to correctly scope the custom task IDs. For example: `custom_task_ids=true&team_id=123`.

• links_tostringObligatorio

  The ID of the second task involved in the link. If `custom_task_ids` is `true`, this should be its custom task ID.

• custom_task_idsboolean

  If `task_id` and `links_to` refer to custom task IDs (rather than standard ClickUp task IDs), this parameter must be set to `true`. Setting this to `true` also requires `team_id` to be provided. Defaults to `false` if not specified.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. Typically, for a successful delete operation, this may be an empty object or include a success status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• group_idstringObligatorio

  The unique string identifier for the Team (user group) to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API's response. Typically, this will be an empty object or include a status confirming successful deletion.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Task ID; can be standard or custom if `custom_task_ids` is set to true.

• team_idinteger

  The ID of the team. This is required only if `custom_task_ids` is set to `true` to correctly identify the task using its custom ID. For example: `custom_task_ids=true&team_id=123`.

• interval_idstringObligatorio

  ID of the time tracking interval (entry) to be deleted.

• custom_task_idsboolean

  Set to `true` if `task_id` refers to a custom task ID. If `true`, `team_id` must also be provided. If omitted or `false`, `task_id` is treated as a standard ID.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary is typically returned upon successful deletion, in line with the legacy endpoint's behavior.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• view_idstringObligatorio

  The unique identifier of the View to be deleted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhook_idstringObligatorio

  The unique identifier (UUID) of the webhook to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Response data. Typically empty for a successful deletion (HTTP 204 No Content).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  New name for the checklist.

• positioninteger

  New 0-indexed display order for the checklist on a task (e.g., 0 for top).

• checklist_idstringObligatorio

  The unique identifier (UUID) of the checklist to be edited.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the updated checklist.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new name for the checklist item.

• parentstring

  The `checklist_item_id` of an existing item within the same checklist to nest this item under.

• assigneestring

  The integer user ID to assign to this checklist item. To unassign, consult ClickUp API documentation for the appropriate value (e.g., 0 or null).

• resolvedboolean

  Set to `true` to mark the item as resolved, or `false` to mark it as unresolved.

• checklist_idstringObligatorio

  The unique identifier (UUID) of the checklist containing the item to be edited.

• checklist_item_idstringObligatorio

  The unique identifier (UUID) of the checklist item to be edited.

Parámetros de salida

• dataobjectObligatorio

  Details of the updated checklist item.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique identifier of the Workspace (Team) where the guest belongs. Example: 123456.

• guest_idintegerObligatorio

  The unique identifier of the guest user to be edited. Example: 98765.

• usernamestringObligatorio

  The new username to assign to the guest.

• can_edit_tagsbooleanObligatorio

  Boolean flag to allow or disallow the guest to edit tags.

• custom_role_idintegerObligatorio

  Identifier of a custom role for the guest. Ensure this ID is valid within the workspace. (Note: Business Plus Plan supports one custom role; Enterprise Plan supports unlimited).

• can_create_viewsbooleanObligatorio

  Boolean flag to allow or disallow the guest to create views.

• can_see_time_spentbooleanObligatorio

  Boolean flag to allow or disallow the guest to see time spent on tasks.

• can_see_time_estimatedbooleanObligatorio

  Boolean flag to allow or disallow the guest to see time estimated for tasks.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• notestringObligatorio

  A note or comment to add or update for the key result.

• key_result_idstringObligatorio

  The unique identifier (UUID) of the key result to be edited.

• steps_currentintegerObligatorio

  The current progress of steps for the key result.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Unique identifier of the Space containing the tag.

• tag_namestringObligatorio

  Current name of the tag to edit. This tag must exist within the specified Space.

• tag__namestring

  New name to assign to the tag.

• tag__bg__colorstring

  New background color for the tag, specified as a hexadecimal string (e.g., '#000000').

• tag__fg__colorstring

  New foreground color for the tag, specified as a hexadecimal string (e.g., '#FFFFFF').

Parámetros de salida

• dataobjectObligatorio

  API response, typically detailing the updated tag.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• endintegerObligatorio

  New end date and time for the interval as a Unix timestamp in milliseconds.

• timeintegerObligatorio

  New total duration of the time interval in milliseconds; typically the difference between `end` and `start`.

• startintegerObligatorio

  New start date and time for the interval as a Unix timestamp in milliseconds.

• task_idstringObligatorio

  Unique task identifier; refers to custom task ID if `custom_task_ids` is true.

• team_idinteger

  Team ID, required if `custom_task_ids` is true.

• interval_idstringObligatorio

  Unique identifier of the time interval record to edit.

• custom_task_idsboolean

  If true, `task_id` is treated as a custom task ID, and `team_id` must be provided.

Parámetros de salida

• dataobjectObligatorio

  Details of the updated time entry.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• adminbooleanObligatorio

  Set `true` to make user an admin, `false` to revoke admin privileges.

• team_idintegerObligatorio

  Workspace (formerly Team) ID where the user resides.

• user_idintegerObligatorio

  ID of the user whose details are to be edited.

• usernamestringObligatorio

  New username to assign.

• custom_role_idintegerObligatorio

  ID of the custom role to assign, defining their permissions.

Parámetros de salida

• dataobjectObligatorio

  Contains the updated user object details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The name of the Folder to be created.

• space_idintegerObligatorio

  Numerical ID of the Space in which to create the Folder.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• archivedboolean

  Filter Folders by archived status. `True` for archived, `False` for unarchived. Omit to return both.

• space_idintegerObligatorio

  The unique numeric identifier of the Space from which to retrieve Folders.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. This typically includes a key (e.g., 'folders') which holds a list of Folder objects and their associated details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• folder_idintegerObligatorio

  The unique identifier of the folder.

Parámetros de salida

• dataobjectObligatorio

  Attributes and details of the specified folder, including its name, lists, and other properties.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  Numeric ID of the specific ClickUp List.

Parámetros de salida

• dataobjectObligatorio

  Contains a 'fields' key: an array of Custom Field objects, each detailing an accessible field's ID, name, type, and configuration for the List.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  Authorization code from ClickUp's authorization server, typically a query parameter to your redirect URI after user consent.

• client_idstringObligatorio

  Client ID for your registered ClickUp OAuth application.

• client_secretstringObligatorio

  Client Secret for your registered ClickUp OAuth application.

Parámetros de salida

• dataobjectObligatorio

  Contains the `access_token` and other token-related details (e.g., token type, expiry time); `access_token` is the primary field.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique numerical identifier of the ClickUp Team (Workspace) for which to retrieve time entry tags.

Parámetros de salida

• dataobjectObligatorio

  The API response data, typically a structure containing a list of tag objects. Each object describes a unique tag (name, colors, attributes) applied to time entries in the specified Workspace.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Contains a list of authorized Workspaces (Teams), where each Workspace object includes details like 'id', 'name', 'color', and 'avatar'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idinteger

  The ID of the team to which the custom task IDs belong. This field is required and used only when the `custom_task_ids` parameter is set to `true`.

• task_idsstringObligatorio

  A comma-separated string of task IDs (e.g., 'taskID1,taskID2') for which to retrieve time in status data. You can include up to 100 task IDs per request.

• custom_task_idsboolean

  Set to `true` if `task_ids` refer to custom task IDs instead of standard task IDs. If `true`, `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  A dictionary where keys are task IDs and values are objects detailing the time spent in each status for that task.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• startinteger

  Unix timestamp (milliseconds) to filter comments created at or after this time. For pagination, typically used with `start_id`.

• view_idstringObligatorio

  Unique identifier of the Chat view from which to retrieve comments.

• start_idstring

  Comment ID to act as a cursor for pagination, used with `start` to retrieve comments after this ID that also meet the `start` time condition.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique identifier of the Workspace (Team) for which to retrieve custom roles.

• include_membersboolean

  If true, includes members assigned to each custom role in the response.

Parámetros de salida

• dataobjectObligatorio

  The API response containing a list of custom roles. If `include_members` was true in the request, each role object also includes its assigned members.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Numeric ID of the Workspace (formerly Team) for which to retrieve custom task types.

Parámetros de salida

• dataobjectObligatorio

  Dictionary where keys are custom task type identifiers and values are their details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  Page to fetch (starts at 0).

• tagsstring[]

  Filter by tag names.

• parentstring

  Filter by parent task ID to retrieve its subtasks.

• reverseboolean

  If true, tasks are displayed in reverse order.

• team_IdstringObligatorio

  Team ID (Workspace).

• team_idinteger

  Team ID, required if `custom_task_ids` is true, for custom task ID context.

• list_idsstring[]

  Filter by List IDs.

• order_bystring

  Order tasks by this field. Default: `created`. Options: `id`, `created`, `updated`, `due_date`.

• statusesstring[]

  Filter by task statuses (e.g., 'to do', 'in progress').

• subtasksboolean

  If true, include subtasks. Excluded by default.

• assigneesstring[]

  Filter by assignee User IDs.

• space_idsstring[]

  Filter by Space IDs.

• due_date_gtinteger

  Filter by due date greater than this Unix timestamp (milliseconds).

• due_date_ltinteger

  Filter by due date less than this Unix timestamp (milliseconds).

• project_idsstring[]

  Filter by Folder (Project) IDs.

• custom_itemsinteger[]

  Filter by custom item types (e.g., 0 for tasks, 1 for Milestones, other numbers for custom types defined in Workspace).

• date_done_gtinteger

  Filter by completion date greater than this Unix timestamp (milliseconds).

• date_done_ltinteger

  Filter by completion date less than this Unix timestamp (milliseconds).

• custom_fieldsstring[]

  Filter by custom fields. Each string in the list is a JSON object defining a single filter condition. Example for one string in the list: '''{"field_id": "unique_field_id", "operator": "=", "value": "desired_value"}'''.

• include_closedboolean

  If true, include closed tasks. Excluded by default.

• custom_task_idsboolean

  Set to true to use custom task IDs in filters instead of global task IDs. Requires `team_id` for context.

• date_created_gtinteger

  Filter by creation date greater than this Unix timestamp (milliseconds).

• date_created_ltinteger

  Filter by creation date less than this Unix timestamp (milliseconds).

• date_updated_gtinteger

  Filter by update date greater than this Unix timestamp (milliseconds).

• date_updated_ltinteger

  Filter by update date less than this Unix timestamp (milliseconds).

• include_markdown_descriptionboolean

  If true, return task descriptions in Markdown format.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• folder_idintegerObligatorio

  The unique identifier of the folder.

Parámetros de salida

• dataobjectObligatorio

  Attributes and details of the specified folder, including its name, lists, and other properties.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• archivedboolean

  Filter by archived status. Set to `true` to retrieve archived Lists, `false` or omit to retrieve unarchived Lists.

• space_idintegerObligatorio

  The ID of the Space from which to retrieve folderless Lists.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the 'lists' key, which holds a list of List objects that are not in any folder within the specified Space.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• archivedboolean

  Filter Folders by archived status. `True` for archived, `False` for unarchived. Omit to return both.

• space_idintegerObligatorio

  The unique numeric identifier of the Space from which to retrieve Folders.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. This typically includes a key (e.g., 'folders') which holds a list of Folder objects and their associated details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• folder_idintegerObligatorio

  ID of the Folder.

Parámetros de salida

• dataobjectObligatorio

  Contains a 'views' key holding a list of view objects, each detailing a configured view (e.g., List, Board, Calendar) for the Folder.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• goal_idstringObligatorio

  The unique identifier (UUID) of the Goal to retrieve.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information of the Goal. This typically includes fields such as `id`, `name`, `description`, `due_date`, `owners`, `key_results` (Targets), `percent_completed`, and `creation_date`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique numerical identifier of the Workspace (Team) for which to retrieve goals.

• include_completedboolean

  If true, include completed goals in the response.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the ClickUp API. This typically includes a list of goal objects under a key such as 'goals'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique identifier for the Team (Workspace) to which the guest belongs.

• guest_idintegerObligatorio

  The unique identifier for the guest whose information is to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  Detailed information of the guest, such as their user object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The unique identifier for the List to retrieve. This ID can be found by right-clicking a List in the ClickUp sidebar, selecting 'Copy link', and the ID is the last part of the URL after '/l/' or '/li/'.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the comprehensive details of the specified List.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• startinteger

  Unix timestamp (milliseconds) of a comment's creation date.

• list_idintegerObligatorio

  The unique identifier for the list from which to retrieve comments.

• start_idstring

  ID of a specific comment.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the array of comment objects retrieved for the list. Each comment object includes details such as commenter, content, and creation date.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  Unique identifier of the ClickUp List. Found by extracting the numerical ID from the List's URL in ClickUp.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing user objects with details about each member of the list.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• archivedboolean

  Filter lists by archived status. If `true`, returns archived lists; if `false` or omitted, returns unarchived lists.

• folder_idintegerObligatorio

  The unique identifier of the Folder from which to retrieve lists.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the lists retrieved from the specified folder.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The ID of the List for which to retrieve views. This is the numeric ID of the list, often found at the end of the list's URL.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique identifier for the Workspace (Team).

• assigneeinteger

  Identifier of the user for the time entry; defaults to the authenticated user if not provided.

Parámetros de salida

• dataobjectObligatorio

  Details of the currently running time entry; a negative 'duration' in this data indicates an active timer.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique identifier for the Team (Workspace).

• timer_idstringObligatorio

  Unique identifier of the time entry. Can be obtained from the 'Get Time Entries Within a Date Range' action.

• include__taskboolean

  If true and the time entry is associated with a task, includes task details in the response.

• include_location_namesboolean

  If true, includes names of the List, Folder, and Space associated with the time entry, alongside their IDs.

Parámetros de salida

• dataobjectObligatorio

  Detailed information of the singular time entry.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Unique ID of the Space to retrieve.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the retrieved Space. Contents may vary based on the Space's configuration, enabled ClickApps (features), and custom fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Identifier for the Team (Workspace).

• archivedboolean

  Filter by archived status (`true` for archived, `false` for active); API default if omitted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  The unique numerical identifier of the Space for which tags are to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing the tags from the specified Space. The 'tags' key holds a list of tag objects, each with details like 'id', 'name', 'tag_fg' (tag foreground color), and 'tag_bg' (tag background color).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  ID of the Space to retrieve views from.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the views within the Space. The keys are view IDs and the values are objects containing view details such as name, type, and parent.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task to retrieve. This can be the standard ClickUp task ID or a custom task ID if `custom_task_ids` is set to `true` (in which case `team_id` is also required).

• team_idinteger

  The ID of the team. This parameter is required and used only when `custom_task_ids` is set to `true` to identify the custom task ID within that specific team. For example: `custom_task_ids=true&team_id=123`.

• custom_task_idsboolean

  Set to `true` to indicate that the `task_id` provided is a custom task ID. If `true`, `team_id` must also be provided. If omitted or `false` (default), `task_id` is treated as a standard task ID.

• include_subtasksboolean

  Set to `true` to include subtasks in the task details response. If omitted or `false` (default), subtasks are not included.

• include_markdown_descriptionboolean

  Set to `true` to return the task description in Markdown format. If omitted or `false` (default), the description is returned in plain text. For example: `?include_markdown_description=true`.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• startinteger

  Unix timestamp (in milliseconds) of the oldest visible comment, used with `start_id` for paginating older comments.

• task_idstringObligatorio

  Unique identifier of the task. Can be a standard or custom task ID (if `custom_task_ids` is true).

• team_idinteger

  Team ID, required if `custom_task_ids` is true.

• start_idstring

  ID of the oldest visible comment, used with `start` for paginating older comments.

• custom_task_idsboolean

  Indicates if `task_id` is a custom task ID; if true, `team_id` is required.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task for which to retrieve members.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageinteger

  The page number of results to fetch, starting at 0. Each page can contain up to 100 tasks.

• tagsstring[]

  Filter tasks by a list of tag names. Use URL encoding for tags with spaces (e.g., 'this%20tag').

• list_idintegerObligatorio

  The ID of the list to retrieve tasks from. To find the list_id, copy the link to the list from the ClickUp UI; the list_id is the number following '/li' in the URL.

• reverseboolean

  Display tasks in reverse order based on the 'order_by' field.

• archivedboolean

  Include or exclude archived tasks.

• order_bystring

  Field to order tasks by. Valid options are: 'id', 'created', 'updated', and 'due_date'.

• statusesstring[]

  Filter tasks by their status. Pass a list of status strings. Use URL encoding for statuses with spaces (e.g., 'to%20do'). To include closed tasks, use the `include_closed` parameter.

• subtasksboolean

  Include subtasks in the results.

• assigneesstring[]

  Filter tasks by a list of assignee IDs.

• due_date_gtinteger

  Filter tasks with a due date greater than the provided Unix timestamp in milliseconds.

• due_date_ltinteger

  Filter tasks with a due date less than the provided Unix timestamp in milliseconds.

• custom_itemsinteger[]

  Filter by custom task types. For example: `?custom_items[]=0&custom_items[]=1300`. Including `0` returns tasks. Including `1` returns Milestones. Including any other number returns the custom task type as defined in your Workspace.

• date_done_gtinteger

  Filter tasks with a completion date greater than the provided Unix timestamp in milliseconds.

• date_done_ltinteger

  Filter tasks with a completion date less than the provided Unix timestamp in milliseconds.

• custom_fieldsstring[]

  Filter tasks by custom field values. Provide a list of JSON strings, each defining a custom field filter. Example for a single filter: '[{"field_id":"field_id_1","operator":"=","value":"field_value_1"}]'. For multiple filters: '[{"field_id":"field_id_1","operator":"=","value":"field_value_1"}, {"field_id":"field_id_2","operator":"<","value":5}]'. See ClickUp API documentation for more on filtering with Custom Fields.

• include_closedboolean

  Include tasks with a closed status.

• date_created_gtinteger

  Filter tasks with a creation date greater than the provided Unix timestamp in milliseconds.

• date_created_ltinteger

  Filter tasks with a creation date less than the provided Unix timestamp in milliseconds.

• date_updated_gtinteger

  Filter tasks with an update date greater than the provided Unix timestamp in milliseconds.

• date_updated_ltinteger

  Filter tasks with an update date less than the provided Unix timestamp in milliseconds.

• include_markdown_descriptionboolean

  Return task descriptions in Markdown format.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task. This can be the standard task ID or a custom task ID if `custom_task_ids` is true.

• team_idinteger

  The ID of the team (Workspace) to which the task belongs. This is required only when `custom_task_ids` is set to `true`. For example: `custom_task_ids=true&team_id=1234567`.

• custom_task_idsboolean

  If set to `true`, the `task_id` parameter will be interpreted as a custom task ID. When using custom task IDs, the `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  An object detailing the time spent in various statuses. It includes `current_status` (object with status name, color, order index, and total time in current status), `status_history` (array of objects, each representing a past status with its details and total time spent), and `total_time_in_workflow` (total time spent across all statuses in minutes).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageintegerObligatorio

  Page number for paginating through templates (starts from 0).

• team_idintegerObligatorio

  Unique identifier of the Workspace (Team) to retrieve task templates from.

Parámetros de salida

• dataobjectObligatorio

  Raw API response, typically including a 'templates' key with a list of task template objects.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idinteger

  ID of the ClickUp Workspace (Team ID) from which to retrieve user groups.

• group_idsstring

  Comma-separated string of user group IDs to filter results; if omitted, all user groups in the Workspace are returned.

Parámetros de salida

• dataobjectObligatorio

  Raw API response. Typically includes a 'groups' key with a list of user group objects, each detailing its ID, name, members, and Workspace ID.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idinteger

  Filter time entries to include only those associated with tasks in a specific List ID.

• task_idstring

  Filter time entries to include only those associated with a specific task ID. Use with `custom_task_ids` if referring to a custom ID.

• team_IdintegerObligatorio

  The ID of the Team (Workspace) for which to retrieve time entries.

• team_idinteger

  The ID of the Team (Workspace) to use for context when `custom_task_ids` is `true`. This helps resolve custom task IDs. Example: `custom_task_ids=true&team_id=123`.

• assigneestring

  Filter time entries by user ID(s). For multiple assignees, provide a comma-separated string of user IDs. Example: `1234,9876`. Note: Access to other users' time entries typically requires Workspace Owner/Admin privileges.

• end_dateinteger

  The end date of the date range for filtering time entries, specified as a Unix timestamp in milliseconds. If omitted, defaults to the current date.

• space_idinteger

  Filter time entries to include only those associated with tasks in a specific Space ID.

• folder_idinteger

  Filter time entries to include only those associated with tasks in a specific Folder ID.

• start_dateinteger

  The start date of the date range for filtering time entries, specified as a Unix timestamp in milliseconds. If omitted, defaults to 30 days prior to the current date.

• custom_task_idsboolean

  Set to `true` if the `task_id` parameter refers to a custom task ID. If `true`, the `team_id` query parameter must also be provided for context.

• include_task_tagsboolean

  If true, includes task tags in the response for time entries associated with tasks.

• include_location_namesboolean

  If true, includes the names of the List, Folder, and Space in the response, along with their respective IDs (`list_id`, `folder_id`, `space_id`).

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique identifier for the Team (Workspace) containing the time entry.

• timer_idstringObligatorio

  Unique identifier of the time entry for which to retrieve history.

Parámetros de salida

• dataobjectObligatorio

  The API response dictionary, which typically includes an array of history items detailing changes to the time entry (e.g., field modified, previous/current values, user, timestamp).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the task for which to retrieve tracked time. This can be the standard task ID or a custom task ID if `custom_task_ids` is set to `true`.

• team_idinteger

  The ID of the team. This is required and used only when the `custom_task_ids` parameter is set to `true`. For example: `custom_task_ids=true&team_id=123`.

• custom_task_idsboolean

  Set to `true` if the `task_id` provided is a custom task ID. If `true`, the `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the tracked time details for the task. This typically includes total time tracked in various units (e.g., milliseconds, hours).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  ID of the Team (Workspace) containing the user.

• user_idintegerObligatorio

  ID of the user whose details are to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  Retrieved user's information, including ID, username, email, profile picture, and role.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• view_idstringObligatorio

  The unique identifier for the ClickUp view to retrieve.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• pageintegerObligatorio

  The page number of the results to retrieve. Used for pagination if the number of tasks exceeds the limit per page. Starts at 0.

• view_idstringObligatorio

  The unique identifier for the view from which to retrieve tasks. Example: "105".

Parámetros de salida

• dataobjectObligatorio

  Tasks from the specified view, structured according to ClickUp's API specifications.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique numerical ID of the Team (Workspace) to retrieve webhooks for.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with a 'webhooks' key, containing an array of webhook objects for the Workspace.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Numeric ID of the Workspace (often referred to as Team ID) for which to retrieve Everything Level views.

Parámetros de salida

• dataobjectObligatorio

  Details of the Everything Level views, typically including a list of view objects with properties like id, name, type (e.g., list, board, calendar), and view-specific settings.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  The unique identifier for the Workspace (formerly known as Team).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing information about the current plan of the Workspace. This may include details like the plan name, features, limits, and usage statistics.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  Numeric ID of the Workspace (Team).

Parámetros de salida

• dataobjectObligatorio

  Details on workspace seats: number of used, total, and available seats for members and guests.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  Email address of the guest to invite to the Workspace.

• team_idintegerObligatorio

  Unique identifier for the Workspace (Team) to which the guest will be invited.

• can_edit_tagsbooleanObligatorio

  If `true`, the guest has permission to edit tags.

• custom_role_idintegerObligatorio

  ID of a custom role to assign to the guest, for granular permission control beyond default guest permissions.

• can_create_viewsbooleanObligatorio

  If `true`, the guest has permission to create views.

• can_see_time_spentbooleanObligatorio

  If `true`, the guest has permission to see time spent on tasks.

• can_see_time_estimatedbooleanObligatorio

  If `true`, the guest has permission to see time estimated for tasks.

Parámetros de salida

• dataobjectObligatorio

  API response, typically including invited guest details or invitation status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• adminbooleanObligatorio

  Grant administrative privileges to the invited user.

• emailstringObligatorio

  Email address of the user to invite.

• team_idintegerObligatorio

  Unique identifier of the Workspace (Team) to which the user will be invited.

• custom_role_idinteger

  Optional custom role ID to assign; if omitted and custom roles are enabled, the default member role is used.

Parámetros de salida

• dataobjectObligatorio

  API response data for the user invitation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• archivedboolean

  Filter lists by archived status. If `true`, returns archived lists; if `false` or omitted, returns unarchived lists.

• folder_idintegerObligatorio

  The unique identifier of the Folder from which to retrieve lists.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the lists retrieved from the specified folder.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  Unique identifier of the ClickUp List. Found by extracting the numerical ID from the List's URL in ClickUp.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing user objects with details about each member of the list.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Identifier of the task. If `custom_task_ids` is true, this is the custom task ID; otherwise, it's the standard task ID.

• team_idinteger

  Numeric ID of the team, required only if `custom_task_ids` is true to identify the task by its custom ID.

• field_idstringObligatorio

  UUID of the Custom Field whose value will be removed from the task.

• custom_task_idsboolean

  If true, `task_id` is a custom task ID, and `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  API response, typically an empty object `{}` on successful removal of the custom field value.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• guest_idintegerObligatorio

  Unique identifier of the guest to remove from the Folder.

• folder_idintegerObligatorio

  Unique identifier of the Folder from which to remove the guest.

• include_sharedboolean

  If `true`, items explicitly shared with the guest within this Folder are also unshared.

Parámetros de salida

• dataobjectObligatorio

  An empty dictionary, `{}`, indicating successful removal.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  The unique identifier of the List from which the guest will be removed.

• guest_idintegerObligatorio

  The unique identifier of the guest to be removed from the List.

• include_sharedboolean

  If `false`, may alter how items shared with the guest are handled or reported during removal.

Parámetros de salida

• dataobjectObligatorio

  An empty object confirming the successful removal of the guest.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the task from which the guest will be removed. This can be the standard task ID or a custom task ID if `custom_task_ids` is set to `true`.

• team_idinteger

  The ID of the team. This is required only when `custom_task_ids` is set to `true` and you are using a custom task ID. For example: `custom_task_ids=true&team_id=123`.

• guest_idintegerObligatorio

  The numeric ID of the guest to be removed from the task.

• include_sharedboolean

  Determines whether to include details of items shared with the guest. Set to `false` to exclude these details. Defaults to `true`.

• custom_task_idsboolean

  Set to `true` if you are using a custom task ID for the `task_id` parameter. If `true`, `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  A dictionary typically confirming the successful removal of the guest. May be an empty object on success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique numerical identifier for the Workspace (often referred to as 'Team' in the ClickUp API) from which the guest is to be removed. This ID specifies the scope of the removal operation.

• guest_idintegerObligatorio

  Unique numerical identifier for the guest user whose access to the specified Workspace will be revoked. This ID targets the specific guest for removal.

Parámetros de salida

• dataobjectObligatorio

  The response payload from the ClickUp API. Upon successful guest removal, this is typically an empty JSON object `{}` or a minimal confirmation object.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The ID of the task from which the tag will be removed. This can be the standard task ID or a custom task ID if `custom_task_ids` is set to `true`.

• team_idinteger

  The Workspace (Team) ID associated with the task.

• tag_namestringObligatorio

  The name of the tag to remove from the task. Tag names are case-sensitive.

• custom_task_idsboolean

  Set to `true` if you are using a custom task ID (instead of the default task ID) to identify the task. If `true`, the `team_id` must also be provided.

Parámetros de salida

• dataobjectObligatorio

  An empty object indicating the successful removal of the tag.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tagsobject[]Obligatorio

  List of tags to remove, typically identified by name (e.g., `{'name': 'tag_name'}`).

• team_idintegerObligatorio

  The unique identifier for the Team (Workspace) that owns the time entries.

• time_entry_idsstring[]Obligatorio

  List of time entry IDs from which to remove tags.

Parámetros de salida

• dataobjectObligatorio

  API response; typically an empty object `{}` on success, or contains error details on failure.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• list_idintegerObligatorio

  Unique numerical identifier of the list from which the task will be removed. This must be an extra list for the task, not its home list.

• task_idstringObligatorio

  Unique identifier of the task to be removed from the specified list.

Parámetros de salida

• dataobjectObligatorio

  Typically an empty dictionary upon successful removal, confirming the operation's success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique numeric identifier of the Workspace (Team) from which the user will be deactivated.

• user_idintegerObligatorio

  The unique numeric identifier of the user to be deactivated from the Workspace.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data. Typically, this is an empty dictionary {} upon successful deactivation of the user, as the primary confirmation is often a 204 HTTP status code with no content.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  Task ID to update. Standard ID, or Custom Task ID if `custom_task_ids` is true.

• team_idinteger

  Team ID, required if `custom_task_ids` is true.

• field_idstringObligatorio

  UUID of the Custom Field to update. Obtainable via 'Get Accessible Custom Fields' or 'Get Task' endpoints.

• custom_task_idsboolean

  If true, `task_id` is treated as a Custom Task ID, and `team_id` is required.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Unique numerical ID of the ClickUp Team (Workspace) for which to fetch the shared hierarchy.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• space_idintegerObligatorio

  Unique ID of the Space to retrieve.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the retrieved Space. Contents may vary based on the Space's configuration, enabled ClickApps (features), and custom fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  Identifier for the Team (Workspace).

• archivedboolean

  Filter by archived status (`true` for archived, `false` for active); API default if omitted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• tidstring

  The ID of the task to associate with this time entry. If `custom_task_ids` is true, this should be the custom task ID.

• tagsobject[]

  Array of tag objects (each with "name", optionally "tag_bg", "tag_fg" for colors) to apply. This feature requires Business Plan or higher. E.g., `[{"name": "Urgent", "tag_bg": "#FF0000"}]`.

• team_IdintegerObligatorio

  Identifier of the Team (Workspace) for this time entry.

• team_idinteger

  The ID of the team for resolving custom task IDs. Required only if `custom_task_ids` is set to `true`. For example: `custom_task_ids=true&team_id=123`.

• billableboolean

  Specifies if the time entry is billable.

• descriptionstring

  Description for the time entry.

• custom_task_idsboolean

  If set to `true`, the `tid` field will be interpreted as a custom task ID. Requires `team_id` query parameter to be set for custom task ID resolution.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idintegerObligatorio

  The unique numeric identifier of the Team (Workspace) where the time entry is being tracked.

Parámetros de salida

• dataobjectObligatorio

  Details of the stopped time entry. The exact structure can vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new checklist.

• task_idstringObligatorio

  Unique identifier of the task for the new checklist; can be a standard or custom task ID (if `custom_task_ids` is true).

• team_idinteger

  Team's unique identifier; required only if `custom_task_ids` is true.

• custom_task_idsboolean

  If true, `task_id` is treated as a custom task ID, requiring `team_id`.

Parámetros de salida

• dataobjectObligatorio

  Dictionary representing the created checklist, including its ID and other attributes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• task_idstringObligatorio

  The unique identifier of the task to retrieve. This can be the standard ClickUp task ID or a custom task ID if `custom_task_ids` is set to `true` (in which case `team_id` is also required).

• team_idinteger

  The ID of the team. This parameter is required and used only when `custom_task_ids` is set to `true` to identify the custom task ID within that specific team. For example: `custom_task_ids=true&team_id=123`.

• custom_task_idsboolean

  Set to `true` to indicate that the `task_id` provided is a custom task ID. If `true`, `team_id` must also be provided. If omitted or `false` (default), `task_id` is treated as a standard task ID.

• include_subtasksboolean

  Set to `true` to include subtasks in the task details response. If omitted or `false` (default), subtasks are not included.

• include_markdown_descriptionboolean

  Set to `true` to return the task description in Markdown format. If omitted or `false` (default), the description is returned in plain text. For example: `?include_markdown_description=true`.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Name for the new team (user group).

• membersinteger[]Obligatorio

  User IDs to be initial members of the new team (user group).

• team_idintegerObligatorio

  Workspace ID where the team (user group) will be created (this is referred to as 'Team ID' in the ClickUp API).

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created team (user group).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  The unique identifier for the Workspace (formerly known as Team).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing information about the current plan of the Workspace. This may include details like the plan name, features, limits, and usage statistics.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not