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.

API name

Adverity UI name

Description

Use in Adverity

Account.{NUM}.id

Account.{NUM}.id

The unique identifier for a ClickUp Workspace, which is referred to as a ‘Team’ in API v2.

dimension

Account.{NUM}.name

Account.{NUM}.name

The name of the ClickUp Workspace, which is referred to as a ‘Team’ in API v2.

dimension

Account.{NUM}.team_id

Account.{NUM}.team_id

The unique identifier for a ClickUp Team, which is synonymous with a Workspace in API v2.

dimension

Attachment

Attachment

A file attached to a task or item.

dimension

Attachments

Attachments

A collection of files attached to a task or item.

dimension

Brief.{NUM}.date

Brief.{NUM}.date

The creation or modification date of the Brief attachment.

metric

Brief.{NUM}.deleted

Brief.{NUM}.deleted

Indicates if a specific brief item has been soft-deleted.

dimension

Brief.{NUM}.extension

Brief.{NUM}.extension

The file extension of the Brief attachment (e.g., pdf, jpg).

dimension

Brief.{NUM}.hidden

Brief.{NUM}.hidden

Indicates if a specific brief item is hidden from view.

dimension

Brief.{NUM}.id

Brief.{NUM}.id

The unique identifier for the Brief attachment.

dimension

Brief.{NUM}.is_folder

Brief.{NUM}.is_folder

Boolean flag indicating if the brief item is a folder.

dimension

Brief.{NUM}.mimetype

Brief.{NUM}.mimetype

The MIME type of the file associated with the brief item, e.g., ‘image/jpeg’ or ‘application/pdf’.

dimension

Brief.{NUM}.orientation

Brief.{NUM}.orientation

dimension

Brief.{NUM}.parent_id

Brief.{NUM}.parent_id

The unique identifier of the parent item (e.g., folder or list) to which this brief item belongs.

dimension

Brief.{NUM}.size

Brief.{NUM}.size

The size of the file associated with the brief item in bytes.

metric

Brief.{NUM}.source

Brief.{NUM}.source

metric

Brief.{NUM}.thumbnail_large

Brief.{NUM}.thumbnail_large

A URL pointing to a large thumbnail image of the Brief attachment.

dimension

Brief.{NUM}.thumbnail_medium

Brief.{NUM}.thumbnail_medium

A URL pointing to a medium thumbnail image of the Brief attachment.

dimension

Brief.{NUM}.thumbnail_small

Brief.{NUM}.thumbnail_small

A URL pointing to a small thumbnail image of the Brief attachment.

dimension

Brief.{NUM}.title

Brief.{NUM}.title

The title or filename of the Brief attachment.

dimension

Brief.{NUM}.type

Brief.{NUM}.type

The type of the brief item, such as ‘file’, ‘document’, or a custom item type.

metric

Brief.{NUM}.url

Brief.{NUM}.url

The direct URL to access the Brief attachment.

dimension

Brief.{NUM}.url_w_host

Brief.{NUM}.url_w_host

The complete URL to access the Brief attachment, including the host domain.

dimension

Brief.{NUM}.url_w_query

Brief.{NUM}.url_w_query

The complete URL to access the Brief attachment, including any query parameters.

dimension

Brief.{NUM}.user.color

Brief.{NUM}.user.color

The color associated with the user who created or last modified the brief item.

dimension

Brief.{NUM}.user.email

Brief.{NUM}.user.email

The email address of the user associated with the brief item.

dimension

Brief.{NUM}.user.id

Brief.{NUM}.user.id

The unique identifier of the user associated with the brief item.

metric

Brief.{NUM}.user.initials

Brief.{NUM}.user.initials

The initials of the user associated with the brief item.

dimension

Brief.{NUM}.user.profilePicture

Brief.{NUM}.user.profilePicture

The URL of the profile picture for the user associated with the brief item.

dimension

Brief.{NUM}.user.username

Brief.{NUM}.user.username

The username of the user associated with the brief item.

dimension

Brief.{NUM}.version

Brief.{NUM}.version

The version identifier of the Brief attachment.

metric

Brief.{NUM}.workspace_id

Brief.{NUM}.workspace_id

The unique identifier of the workspace to which the brief item belongs.

dimension

Contract.{NUM}.date

Contract.{NUM}.date

The creation or modification date of the Contract attachment.

metric

Contract.{NUM}.deleted

Contract.{NUM}.deleted

Indicates if a specific contract item has been soft-deleted.

dimension

Contract.{NUM}.extension

Contract.{NUM}.extension

The file extension of the Contract attachment (e.g., pdf, docx).

dimension

Contract.{NUM}.hidden

Contract.{NUM}.hidden

Indicates if a specific contract item is hidden from view.

dimension

Contract.{NUM}.id

Contract.{NUM}.id

The unique identifier for the Contract attachment.

dimension

Contract.{NUM}.is_folder

Contract.{NUM}.is_folder

Boolean flag indicating if the contract item is a folder.

dimension

Contract.{NUM}.mimetype

Contract.{NUM}.mimetype

The MIME type of the file associated with the contract item, e.g., ‘image/jpeg’ or ‘application/pdf’.

dimension

Contract.{NUM}.orientation

Contract.{NUM}.orientation

dimension

Contract.{NUM}.parent_id

Contract.{NUM}.parent_id

The unique identifier of the parent item (e.g., folder or list) to which this contract item belongs.

dimension

Contract.{NUM}.size

Contract.{NUM}.size

The size of the file associated with the contract item in bytes.

metric

Contract.{NUM}.source

Contract.{NUM}.source

metric

Contract.{NUM}.thumbnail_large

Contract.{NUM}.thumbnail_large

A URL pointing to a large thumbnail image of the Contract attachment.

dimension

Contract.{NUM}.thumbnail_medium

Contract.{NUM}.thumbnail_medium

A URL pointing to a medium thumbnail image of the Contract attachment.

dimension

Contract.{NUM}.thumbnail_small

Contract.{NUM}.thumbnail_small

A URL pointing to a small thumbnail image of the Contract attachment.

dimension

Contract.{NUM}.title

Contract.{NUM}.title

The title or filename of the Contract attachment.

dimension

Contract.{NUM}.type

Contract.{NUM}.type

The type of the contract item, such as ‘file’, ‘document’, or a custom item type.

metric

Contract.{NUM}.url

Contract.{NUM}.url

The direct URL to access the Contract attachment.

dimension

Contract.{NUM}.url_w_host

Contract.{NUM}.url_w_host

The complete URL to access the Contract attachment, including the host domain.

dimension

Contract.{NUM}.url_w_query

Contract.{NUM}.url_w_query

The complete URL to access the Contract attachment, including any query parameters.

dimension

Contract.{NUM}.user.color

Contract.{NUM}.user.color

The color associated with the user who created or last modified the contract item.

dimension

Contract.{NUM}.user.email

Contract.{NUM}.user.email

The email address of the user associated with the contract item.

dimension

Contract.{NUM}.user.id

Contract.{NUM}.user.id

The unique identifier of the user associated with the contract item.

metric

Contract.{NUM}.user.initials

Contract.{NUM}.user.initials

The initials of the user associated with the contract item.

dimension

Contract.{NUM}.user.profilePicture

Contract.{NUM}.user.profilePicture

The URL of the profile picture for the user associated with the contract item.

dimension

Contract.{NUM}.user.username

Contract.{NUM}.user.username

The username of the user associated with the contract item.

dimension

Contract.{NUM}.version

Contract.{NUM}.version

The version identifier of the Contract attachment.

metric

Deadline

Deadline

The designated due date or deadline for a task.

dimension

Due date

Due date

The date when the task or item is due.

metric

Due date

Due date

The date when the task or item is due.

dimension

Last Updated

Last Updated

The date and time when the task or item was last updated.

metric

Owner

Owner

Represents a user designated as the owner of a task or other ClickUp entity.

dimension

Owner.{NUM}.color

Owner.{NUM}.color

The color associated with the owner’s user profile in ClickUp.

dimension

Owner.{NUM}.email

Owner.{NUM}.email

The email address of the user who is the owner.

dimension

Owner.{NUM}.id

Owner.{NUM}.id

The unique identifier of the user who owns the task or item.

metric

Owner.{NUM}.initials

Owner.{NUM}.initials

The initials of the user who is the owner.

dimension

Owner.{NUM}.profilePicture

Owner.{NUM}.profilePicture

The URL to the profile picture of the owner’s user profile.

dimension

Owner.{NUM}.username

Owner.{NUM}.username

The username of the owner of the task or item.

dimension

Progress.percent_complete

Progress.percent_complete

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

metric

Requested by

Requested by

Represents a user who initiated or requested a task or other action within ClickUp.

dimension

Requested by.{NUM}.color

Requested by.{NUM}.color

The color associated with the user profile of the person who requested the task or item.

dimension

Requested by.{NUM}.email

Requested by.{NUM}.email

The email address of the user who made the request.

dimension

Requested by.{NUM}.id

Requested by.{NUM}.id

The unique identifier of the user who requested the task or item.

metric

Requested by.{NUM}.initials

Requested by.{NUM}.initials

The initials of the user who made the request.

dimension

Requested by.{NUM}.profilePicture

Requested by.{NUM}.profilePicture

The URL to the profile picture of the user who requested the task or item.

dimension

Requested by.{NUM}.username

Requested by.{NUM}.username

The username of the person who requested the task or item.

dimension

Role

Role

The role of a user within a workspace or team, defining their permissions and access levels.

dimension

Task

Task

The name or title of a task.

dimension

Task Progress.percent_complete

Task Progress.percent_complete

The percentage of completion for the task.

metric

Teams

Teams

A collection of teams (workspaces) within ClickUp.

dimension

archived

archived

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

dimension

assignees.color

assignees.color

The color associated with the user profile of an assignee.

dimension

assignees.email

assignees.email

The email address of a user assigned to the task.

dimension

assignees.id

assignees.id

The unique identifier of a user assigned to the task.

metric

assignees.initials

assignees.initials

The initials of a user assigned to the task.

dimension

assignees.profilePicture

assignees.profilePicture

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

dimension

assignees.username

assignees.username

The username of a user assigned to the task.

dimension

attachments.{NUM}.date

attachments.{NUM}.date

The date and time when the attachment was uploaded, in Unix time in milliseconds.

metric

attachments.{NUM}.deleted

attachments.{NUM}.deleted

A boolean indicating if the attachment has been deleted.

dimension

attachments.{NUM}.email_data

attachments.{NUM}.email_data

dimension

attachments.{NUM}.email_data.client

attachments.{NUM}.email_data.client

dimension

attachments.{NUM}.email_data.email

attachments.{NUM}.email_data.email

The email address associated with the email attachment.

dimension

attachments.{NUM}.email_data.from

attachments.{NUM}.email_data.from

dimension

attachments.{NUM}.email_data.id

attachments.{NUM}.email_data.id

dimension

attachments.{NUM}.email_data.msg

attachments.{NUM}.email_data.msg

dimension

attachments.{NUM}.email_data.subject

attachments.{NUM}.email_data.subject

dimension

attachments.{NUM}.extension

attachments.{NUM}.extension

The file extension of the attachment (e.g., pdf, jpg).

dimension

attachments.{NUM}.hidden

attachments.{NUM}.hidden

A boolean indicating if the attachment is hidden.

dimension

attachments.{NUM}.id

attachments.{NUM}.id

The unique identifier of the attachment.

dimension

attachments.{NUM}.is_folder

attachments.{NUM}.is_folder

A boolean indicating if the attachment item is a folder.

dimension

attachments.{NUM}.mimetype

attachments.{NUM}.mimetype

The MIME type of the attachment (e.g., application/pdf, image/jpeg).

dimension

attachments.{NUM}.orientation

attachments.{NUM}.orientation

The orientation of the attachment, if applicable (e.g., for images).

dimension

attachments.{NUM}.parent_id

attachments.{NUM}.parent_id

The unique identifier of the parent task or item to which the attachment belongs.

dimension

attachments.{NUM}.resolved_comments

attachments.{NUM}.resolved_comments

The number of comments that have been resolved for this attachment.

metric

attachments.{NUM}.size

attachments.{NUM}.size

The size of the attachment in bytes.

metric

attachments.{NUM}.source

attachments.{NUM}.source

The source or origin of the attachment (e.g., direct upload, Google Drive).

metric

attachments.{NUM}.thumbnail_large

attachments.{NUM}.thumbnail_large

The URL to a large thumbnail image of the attachment, if available.

dimension

attachments.{NUM}.thumbnail_medium

attachments.{NUM}.thumbnail_medium

The URL to a medium thumbnail image of the attachment, if available.

dimension

attachments.{NUM}.thumbnail_small

attachments.{NUM}.thumbnail_small

The URL to a small thumbnail image of the attachment, if available.

dimension

attachments.{NUM}.title

attachments.{NUM}.title

The title or name of the attachment.

dimension

attachments.{NUM}.total_comments

attachments.{NUM}.total_comments

The total number of comments associated with this attachment.

metric

attachments.{NUM}.type

attachments.{NUM}.type

The type of the attachment (e.g., ‘image’, ‘file’).

metric

attachments.{NUM}.url

attachments.{NUM}.url

The URL to access the attachment.

dimension

attachments.{NUM}.url_w_host

attachments.{NUM}.url_w_host

The URL to access the attachment, including the host.

dimension

attachments.{NUM}.url_w_query

attachments.{NUM}.url_w_query

The URL to access the attachment, including query parameters.

dimension

attachments.{NUM}.user.color

attachments.{NUM}.user.color

The color associated with the user profile of the person who uploaded the attachment.

dimension

attachments.{NUM}.user.email

attachments.{NUM}.user.email

The email address of the user who uploaded the attachment.

dimension

attachments.{NUM}.user.id

attachments.{NUM}.user.id

The unique identifier of the user who uploaded the attachment.

metric

attachments.{NUM}.user.initials

attachments.{NUM}.user.initials

The initials of the user who uploaded the attachment.

dimension

attachments.{NUM}.user.profilePicture

attachments.{NUM}.user.profilePicture

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

dimension

attachments.{NUM}.user.username

attachments.{NUM}.user.username

The username of the person who uploaded the attachment.

dimension

attachments.{NUM}.version

attachments.{NUM}.version

The version of the attachment, if versioning is enabled.

metric

checklists.creator

checklists.creator

The user who created the checklist.

metric

checklists.date_created

checklists.date_created

The date and time when the checklist was created.

metric

checklists.id

checklists.id

The unique identifier of the checklist.

dimension

checklists.items

checklists.items

A list of items within the checklist.

dimension

checklists.name

checklists.name

The name of the checklist.

dimension

checklists.orderindex

checklists.orderindex

The numerical index used to determine the order of the checklist on a task.

metric

checklists.resolved

checklists.resolved

The number of resolved items within the checklist.

metric

checklists.task_id

checklists.task_id

The unique identifier of the task to which the checklist belongs.

dimension

checklists.unresolved

checklists.unresolved

The number of unresolved items within the checklist.

metric

creator.color

creator.color

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

dimension

creator.email

creator.email

The email address of the user who created the task.

dimension

creator.id

creator.id

The unique identifier of the user who created the task.

metric

creator.profilePicture

creator.profilePicture

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

dimension

creator.username

creator.username

The username of the person who created the task.

dimension

custom_id

custom_id

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

dimension

date_closed

date_closed

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

dimension

date_created

date_created

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

dimension

date_done

date_done

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

dimension

date_updated

date_updated

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

dimension

dependencies.chain_id

dependencies.chain_id

The identifier for a chain of dependent tasks.

dimension

dependencies.date_created

dependencies.date_created

The timestamp indicating when the task dependency was established.

metric

dependencies.depends_on

dependencies.depends_on

The ID of the task that the current task depends on (i.e., the blocking task).

dimension

dependencies.task_id

dependencies.task_id

The ID of the task for which the dependency is defined.

dimension

dependencies.type

dependencies.type

The type of dependency (e.g., ‘waiting_on’, ‘blocking’).

metric

dependencies.userid

dependencies.userid

The ID of the user who created the task dependency.

metric

dependencies.workspace_id

dependencies.workspace_id

The ID of the Workspace containing the task dependency.

dimension

description

description

A detailed description of the task or item.

dimension

due_date

due_date

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

dimension

folder.access

folder.access

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

dimension

folder.hidden

folder.hidden

A boolean indicating if the folder is hidden from view.

dimension

folder.id

folder.id

The unique identifier of the folder.

metric

folder.name

folder.name

The name of the folder.

dimension

group_assignees.{NUM}.color

group_assignees.{NUM}.color

The color associated with a user in the assigned group.

dimension

group_assignees.{NUM}.email

group_assignees.{NUM}.email

The email address of a user in the assigned group.

dimension

group_assignees.{NUM}.id

group_assignees.{NUM}.id

The unique identifier of a user in the assigned group.

dimension

group_assignees.{NUM}.initials

group_assignees.{NUM}.initials

The initials of an assignee within a group.

dimension

group_assignees.{NUM}.name

group_assignees.{NUM}.name

The full name of an assignee within a group.

dimension

id

id

The unique identifier of the task or item.

dimension

linked_tasks.date_created

linked_tasks.date_created

The timestamp indicating when the link between tasks was created.

metric

linked_tasks.link_id

linked_tasks.link_id

The unique identifier for the specific link established between two tasks.

dimension

linked_tasks.task_id

linked_tasks.task_id

The ID of a task that is linked to another task.

dimension

linked_tasks.userid

linked_tasks.userid

The ID of the user who created the linked task relationship.

metric

linked_tasks.workspace_id

linked_tasks.workspace_id

The ID of the Workspace where the linked task is located.

dimension

list.access

list.access

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

dimension

list.id

list.id

The unique identifier of the list containing the task.

metric

list.name

list.name

The name of the list containing the task.

dimension

locations.{NUM}.id

locations.{NUM}.id

The unique identifier for a specific location within ClickUp’s hierarchy, such as a Space, Folder, or List.

metric

locations.{NUM}.name

locations.{NUM}.name

The name of a specific location within ClickUp’s hierarchy.

dimension

name

name

The name or title of the task or item.

dimension

orderindex

orderindex

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

metric

parent

parent

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

dimension

permission_level

permission_level

The permission level of the current user for the item.

dimension

points

points

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

dimension

priority

priority

The priority level of the task.

dimension

priority.color

priority.color

The color associated with the task’s priority level.

dimension

priority.id

priority.id

The unique identifier of the task’s priority level.

metric

priority.orderindex

priority.orderindex

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

metric

priority.priority

priority.priority

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

dimension

project.access

project.access

Indicates whether the project is accessible. This field typically denotes public or private status.

dimension

project.hidden

project.hidden

Boolean flag indicating if the project is hidden from view.

dimension

project.id

project.id

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

metric

project.name

project.name

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

dimension

sharing.permission_level

sharing.permission_level

The permission level for sharing the item (e.g., ‘read-only’, ‘edit’).

metric

sharing.permissions.can_comment

sharing.permissions.can_comment

A boolean indicating if users with these permissions can comment on the item.

dimension

sharing.permissions.name

sharing.permissions.name

The name of the permission set for sharing (e.g., ‘Guest’, ‘Member’).

dimension

space

space

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

dimension

space.id

space.id

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

metric

start_date

start_date

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

dimension

status.color

status.color

The color associated with the task’s status.

dimension

status.id

status.id

The unique identifier of the task’s status.

dimension

status.orderindex

status.orderindex

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

metric

status.status

status.status

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

dimension

status.type

status.type

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

dimension

tag

tag

A label used for categorizing and organizing tasks. Tasks can have multiple tags for easy filtering and management.

dimension

tags.name

tags.name

The name of a tag associated with the task.

dimension

team

team

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

dimension

team_id

team_id

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

dimension

text_content

text_content

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

dimension

time_estimate

time_estimate

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

dimension

time_estimates_by_user.{NUM}.time_estimate

time_estimates_by_user.{NUM}.time_estimate

The estimated time for a task assigned to a specific user, in milliseconds.

metric

time_estimates_by_user.{NUM}.user.color

time_estimates_by_user.{NUM}.user.color

The color associated with the user profile for whom the time estimate is set.

dimension

time_estimates_by_user.{NUM}.user.email

time_estimates_by_user.{NUM}.user.email

The email address of the user for whom the time estimate is set.

dimension

time_estimates_by_user.{NUM}.user.id

time_estimates_by_user.{NUM}.user.id

The unique identifier of the user for whom the time estimate is set.

metric

time_estimates_by_user.{NUM}.user.initials

time_estimates_by_user.{NUM}.user.initials

The initials of the user for whom the time estimate is set.

dimension

time_estimates_by_user.{NUM}.user.profilePicture

time_estimates_by_user.{NUM}.user.profilePicture

The URL to the profile picture of the user for whom the time estimate is set.

dimension

time_estimates_by_user.{NUM}.user.username

time_estimates_by_user.{NUM}.user.username

The username of the person for whom the time estimate is set.

dimension

time_spent

time_spent

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

metric

url

url

The URL to access the task or item in ClickUp.

dimension

watchers.color

watchers.color

The color associated with the user profile of a person watching the task.

dimension

watchers.email

watchers.email

The email address of a user watching the task.

dimension

watchers.id

watchers.id

The unique identifier of a user watching the task.

metric

watchers.initials

watchers.initials

The initials of a user watching the task.

dimension

watchers.profilePicture

watchers.profilePicture

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

dimension

watchers.username

watchers.username

The username of a person watching the task.

dimension