ClickUp: Most-used fields

ClickUp: Most-used fields#

The table below gives information about most-used fields that you can import from ClickUp. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

FieldAdverity UI nameType
Attachments Dimension

A collection of files or content associated with a task or other ClickUp entity.

Progress.percent_complete Metric

The percentage of completion for a task or a progress-related custom field.

Space URL Dimension
Task Progress.percent_complete Metric

The percentage of completion for the task.

User Name Dimension

The display name of the user.

User Type Dimension

The type or role of the user within ClickUp, such as Owner, Admin, Member, or Guest.

archived Dimension

A boolean indicating whether an entity (e.g., Space, Folder, List, or Task) is archived.

assignees.color Dimension

The color associated with the user profile of an assignee.

assignees.email Dimension

The email address of a user assigned to the task.

assignees.id Metric

The unique identifier of a user assigned to the task.

assignees.initials Dimension

The initials of a user assigned to the task.

assignees.profilePicture Dimension

The URL to the profile picture of a user assigned to the task.

assignees.username Dimension

The username of a user assigned to the task.

attachments.{NUM}.date Metric

The timestamp indicating when the attachment was created or uploaded.

attachments.{NUM}.deleted Dimension
attachments.{NUM}.email_data Dimension

An object containing metadata specific to email attachments, such as sender, recipient, and subject.

attachments.{NUM}.email_data.client Dimension
attachments.{NUM}.email_data.email Dimension
attachments.{NUM}.email_data.from Dimension
attachments.{NUM}.email_data.id Dimension
attachments.{NUM}.email_data.msg Dimension
attachments.{NUM}.email_data.subject Dimension
attachments.{NUM}.extension Dimension

The file extension of the attached file (e.g., 'pdf', 'jpg', 'doc').

attachments.{NUM}.hidden Dimension
attachments.{NUM}.id Dimension

The unique identifier of the attachment.

attachments.{NUM}.is_folder Dimension
attachments.{NUM}.mimetype Dimension

The MIME type of the attachment, indicating its file format (e.g., 'image/jpeg', 'application/pdf').

attachments.{NUM}.orientation Dimension
attachments.{NUM}.parent_id Dimension

The unique identifier of the parent entity (e.g., task, comment) to which this attachment belongs.

attachments.{NUM}.resolved_comments Metric
attachments.{NUM}.size Metric

The size of the attachment in bytes.

attachments.{NUM}.source Metric
attachments.{NUM}.thumbnail_large Dimension

The URL for a larger-sized thumbnail image of the attachment.

attachments.{NUM}.thumbnail_medium Dimension

The URL for a medium-sized thumbnail image of the attachment.

attachments.{NUM}.thumbnail_small Dimension

The URL for a smaller-sized thumbnail image of the attachment.

attachments.{NUM}.title Dimension

The display title or name of the attachment.

attachments.{NUM}.total_comments Metric
attachments.{NUM}.type Metric

The classification or category of the attachment (e.g., 'image', 'file', 'email').

attachments.{NUM}.url Dimension

The direct URL to access or download the attachment.

attachments.{NUM}.url_w_host Dimension

The full URL of the attachment, including its host domain.

attachments.{NUM}.url_w_query Dimension

The full URL of the attachment, including any query parameters appended to it.

attachments.{NUM}.user.color Dimension

The display color assigned to the user who uploaded the attachment, often used for UI representation.

attachments.{NUM}.user.email Dimension

The email address of the user associated with the attachment.

attachments.{NUM}.user.id Metric

The unique identifier of the user who uploaded the attachment.

attachments.{NUM}.user.initials Dimension

The initials of the user who uploaded the attachment.

attachments.{NUM}.user.profilePicture Dimension

The URL for the profile picture of the user who uploaded the attachment.

attachments.{NUM}.user.username Dimension

The username of the user associated with the attachment.

attachments.{NUM}.version Metric

The version number of the attachment.

checklists.creator Metric

Details about the user who created the checklist.

checklists.date_created Metric

The date and time when the checklist was created within a task. This timestamp indicates when the checklist was first added.

checklists.id Dimension

The unique identifier of the checklist.

checklists.items Dimension

A list of individual items contained within the checklist.

checklists.name Dimension

The name or title of the checklist.

checklists.orderindex Metric

The order index of the checklist, defining its position relative to other checklists or elements.

checklists.resolved Metric

The number of resolved (completed) items in the checklist.

checklists.task_id Dimension

The unique identifier of the task to which the checklist is associated.

checklists.unresolved Metric

The number of unresolved (pending) items in the checklist.

creator.color Dimension

The color associated with the user profile of the task's creator.

creator.email Dimension

The email address of the user who created the task.

creator.id Metric

The unique identifier of the user who created the task.

creator.profilePicture Dimension

The URL to the profile picture of the task's creator.

creator.username Dimension

The username of the person who created the task.

custom_id Dimension

A custom identifier for the task, often used for external system integration. This is an optional field set by the user.

date_closed Dimension

The date and time when the task was marked as closed, in Unix time in milliseconds.

date_created Dimension

The date and time when the task or item was created, in Unix time in milliseconds.

date_done Dimension

This field represents the date and time when a task was marked as complete or done.

date_updated Dimension

The date and time when the task or item was last updated, in Unix time in milliseconds.

dependencies.chain_id Dimension

A unique identifier for a sequence or chain of related task dependencies.

dependencies.date_created Metric

The timestamp (in Unix milliseconds) when this specific task dependency was created. [1]

dependencies.depends_on Dimension

The unique identifier of the task that must be completed before the current task can proceed.

dependencies.task_id Dimension

The unique identifier of the task for which this dependency is defined.

dependencies.type Metric

The type of relationship between dependent tasks (e.g., 'waiting on', 'blocking', 'linked').

dependencies.userid Metric

The unique identifier of the user who created or last modified this task dependency. [1]

dependencies.workspace_id Dimension

The unique identifier of the workspace to which this dependency belongs.

description Dimension

A detailed description of the task or item.

due_date Dimension

The date and time when the task is due, in Unix time in milliseconds.

folder.access Dimension

A boolean indicating if the current user has access to the folder.

folder.hidden Dimension

A boolean indicating if the folder is hidden from view.

folder.id Metric

The unique identifier of the folder.

folder.name Dimension

The name of the folder.

id Dimension

The unique identifier of the task or item.

linked_tasks.date_created Metric

The date and time when a task link relationship was established between two tasks. This indicates when one task was linked to another.

linked_tasks.link_id Dimension

The unique identifier for the task link or relationship.

linked_tasks.task_id Dimension

The unique identifier of the linked task.

linked_tasks.userid Metric

The unique identifier of the user who created the task link.

linked_tasks.workspace_id Dimension

The unique identifier of the workspace to which the linked task belongs.

list.access Dimension

A boolean indicating if the current user has access to the list.

list.id Metric

The unique identifier of the list containing the task.

list.name Dimension

The name of the list containing the task.

locations.{NUM}.id Metric

This field represents the unique identifier for a specific hierarchical location within ClickUp, such as a Space, Folder, or List.

locations.{NUM}.name Dimension

This field provides the name of a specific hierarchical location within ClickUp, such as a Space, Folder, or List.

name Dimension

The name or title of the task or item.

orderindex Metric

The numerical index used to determine the order of the item within its parent (e.g., task within a list, list within a folder).

parent Dimension

The unique identifier of the parent task, if the current item is a subtask.

permission_level Dimension

The permission level of the current user for the item.

points Metric

The number of points assigned to the task, used to quantify task size or effort.

priority Dimension

The priority level of the task.

priority.color Dimension

The color associated with the task's priority level.

priority.id Metric

The unique identifier of the task's priority level.

priority.orderindex Metric

The numerical index used to determine the order of the task's priority.

priority.priority Dimension

The name of the task's priority level (e.g., 'Urgent', 'High', 'Normal', 'Low').

project.id Metric

The unique identifier for a project in ClickUp, which corresponds to a Space, Folder, or List.

project.name Dimension

The name of the project, which corresponds to a Space, Folder, or List in ClickUp.

sharing.permission_level Metric

The overall permission level for sharing the entity (e.g., 'public', 'private', 'read-only').

sharing.permissions.can_comment Dimension

A boolean indicating if commenting is allowed for the specific permission.

sharing.permissions.name Dimension

The name of the specific permission applied (e.g., 'View', 'Edit', 'Comment').

space Dimension

The name or object representing the Space where the item is located.

space.id Metric

The unique identifier of the Space where the item is located.

start_date Dimension

The date and time when the task is scheduled to start, in Unix time in milliseconds.

status.color Dimension

The color associated with the task's status.

status.id Dimension

The unique identifier of the status associated with a task or list.

status.orderindex Metric

The numerical index used to determine the order of the task's status within its workflow.

status.status Dimension

The name of the task's status (e.g., 'Open', 'In Progress', 'Complete').

status.type Dimension

The type of the task's status (e.g., 'open', 'closed', 'custom').

tags.name Dimension

The name of a tag associated with the task.

team Dimension

The name or object representing the Team (Workspace) where the item is located.

team_id Dimension

The unique identifier of the Team (Workspace) where the item is located.

text_content Dimension

The plain text content of the task's description or other text fields.

time_estimate Dimension

The estimated time required to complete the task, in milliseconds.

time_estimates_by_user.{NUM}.time_estimate Metric

This field represents the estimated amount of time allocated for a task by a specific user or assignee.

time_estimates_by_user.{NUM}.user.color Dimension

The color associated with the user who provided the time estimate.

time_estimates_by_user.{NUM}.user.email Dimension

The email address of the user who provided the time estimate.

time_estimates_by_user.{NUM}.user.id Metric

The unique identifier of the user who provided the time estimate.

time_estimates_by_user.{NUM}.user.initials Dimension

The initials of the user who provided the time estimate.

time_estimates_by_user.{NUM}.user.profilePicture Dimension

The URL to the profile picture of the user who provided the time estimate, if available.

time_estimates_by_user.{NUM}.user.username Dimension

The username of the user who provided the time estimate.

time_spent Metric

The total time spent on the task, in milliseconds. This field is only included for tasks with time entries.

url Dimension

The URL to access the task or item in ClickUp.

watchers.color Dimension

The color associated with the watcher.

watchers.email Dimension

The email address of the watcher.

watchers.id Metric

The unique identifier of the watcher.

watchers.initials Dimension

The initials of the watcher.

watchers.profilePicture Dimension

The URL to the profile picture of the watcher, if available.

watchers.username Dimension

The username of the watcher.