ClickUp
Visão geral
Seção intitulada “Visão geral”ClickUp é uma plataforma all-in-one de produtividade que unifica tarefas, documentos, metas e chat em um único lugar, permitindo que equipes planejem, organizem e colaborem em projetos com fluxos de trabalho personalizáveis. Com a integração ClickUp no SquadOS, seus agentes podem criar tarefas, atualizar status, consultar listas, registrar horas trabalhadas e manipular documentos diretamente pela API, sem sair do fluxo de trabalho automatizado.
- Site oficial: https://clickup.com/
- Documentação na Composio: docs.composio.dev/toolkits/clickup
Autenticação
Seção intitulada “Autenticação”Esta ferramenta suporta OAuth 2.0 (OAUTH2) e chave de API (API_KEY) para conectar.
Para OAuth 2.0, o acesso é autorizado diretamente pela sua conta ClickUp — nenhuma chave manual é necessária.
Para autenticação via chave de API, você vai precisar dos seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Chave de API pessoal gerada no painel ClickUp em Configurações → Aplicativos. |
Como obter a credencial
Seção intitulada “Como obter a credencial”Os passos abaixo se aplicam à autenticação via chave de API. Se preferir OAuth 2.0, pule para a seção “Como conectar no SquadOS”.
- Faça login em app.clickup.com.
- Clique no avatar do usuário no canto inferior esquerdo e acesse Configurações (Settings).
- Na barra lateral, vá em Aplicativos (Apps).
- Na seção Chave de API, clique em Gerar (ou copie a chave já exibida).
- Copie o valor — esse é o
api_keya informar ao conectar no SquadOS.
Como conectar no SquadOS
Seção intitulada “Como conectar no SquadOS”- Acesse Ferramentas no menu lateral (
/admin/tools). - Abra a aba Disponíveis e procure por
ClickUp. - Clique no card para abrir o modal de detalhes e em Conectar.
- Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso via OAuth 2.0 ou informa a chave de API obtida acima.
- Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)
Ações disponíveis
Seção intitulada “Ações disponíveis”Criar tarefa
Seção intitulada “Criar tarefa”CLICKUP_CREATE_TASK
Cria uma nova tarefa do ClickUp em uma lista específica, podendo criá-la como subtarefa se um parent for informado (o pai não pode ser subtarefa e deve estar na mesma lista).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | ID da lista onde a tarefa será criada. |
name | string | Sim | Nome da nova tarefa. |
description | string | Não | Descrição detalhada da tarefa. |
status | string | Não | Status da tarefa. Cada lista tem seus próprios status configurados — use exatamente o nome (case-sensitive) definido na lista alvo. Se omitido, usa o status padrão da lista. |
priority | integer | Não | Nível de prioridade: 1 (Urgente), 2 (Alta), 3 (Normal), 4 (Baixa). |
due_date | integer | Não | Data de vencimento como timestamp Unix em milissegundos. |
assignees | array | Não | IDs dos usuários a atribuir à tarefa. |
tags | array | Não | Nomes de tags a aplicar. |
parent | string | Não | ID da tarefa pai para criar como subtarefa (o pai deve estar na mesma lista e não pode ser subtarefa). |
team_id | string | Não | ID do time — obrigatório se custom_task_ids for verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter tarefa
Seção intitulada “Obter tarefa”CLICKUP_GET_TASK
Recupera os detalhes completos de uma tarefa do ClickUp pelo seu ID, suportando IDs padrão ou personalizados (requer team_id para IDs personalizados).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | Identificador único da tarefa a recuperar. |
include_subtasks | boolean | Não | Se verdadeiro, inclui subtarefas nos detalhes retornados. |
include_markdown_description | boolean | Não | Se verdadeiro, retorna a descrição da tarefa em formato Markdown. |
custom_task_ids | boolean | Não | Verdadeiro se task_id for um ID personalizado — exige team_id. |
team_id | integer | Não | ID do time — obrigatório quando custom_task_ids é verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar tarefas
Seção intitulada “Listar tarefas”CLICKUP_GET_TASKS
Recupera tarefas de uma lista do ClickUp especificada. Somente tarefas cuja lista principal é a indicada são retornadas. Tarefas fechadas e arquivadas são excluídas por padrão.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | ID da lista. Para encontrá-lo, copie o link da lista no ClickUp — é o número após /li na URL. |
page | integer | Não | Número da página (começa em 0). Cada página retorna até 100 tarefas. |
statuses | array | Não | Filtro por status (strings exatas, case-sensitive, conforme configuração do workspace). |
assignees | array | Não | Filtro por IDs de usuários atribuídos. |
tags | array | Não | Filtro por nomes de tags. |
order_by | string | Não | Campo de ordenação: id, created, updated ou due_date. |
include_closed | boolean | Não | Se verdadeiro, inclui tarefas com status fechado. |
subtasks | boolean | Não | Se verdadeiro, inclui subtarefas nos resultados. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar tarefa
Seção intitulada “Atualizar tarefa”CLICKUP_UPDATE_TASK
Atualiza atributos de uma tarefa existente. Use um único espaço (" ") para description se quiser limpar a descrição. Informe ao menos um campo modificável.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | Identificador único da tarefa. |
name | string | Não | Novo nome da tarefa. |
description | string | Não | Nova descrição; use um espaço simples para limpar. |
status | string | Não | Novo status (case-sensitive, deve existir no workspace). |
priority | integer | Não | Prioridade: 1 (Urgente), 2 (Alta), 3 (Normal), 4 (Baixa). |
due_date | integer | Não | Nova data de vencimento (timestamp Unix em milissegundos). |
assignees__add | array | Não | IDs de usuários a adicionar como responsáveis. |
assignees__rem | array | Não | IDs de usuários a remover como responsáveis. |
archived | boolean | Não | Verdadeiro para arquivar; falso para desarquivar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir tarefa
Seção intitulada “Excluir tarefa”CLICKUP_DELETE_TASK
Exclui permanentemente uma tarefa do ClickUp pelo seu ID.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | Identificador único da tarefa a excluir. |
custom_task_ids | boolean | Não | Verdadeiro se task_id for um ID personalizado — exige team_id. |
team_id | string | Não | ID do time — obrigatório quando custom_task_ids é verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar tarefas filtradas no workspace
Seção intitulada “Buscar tarefas filtradas no workspace”CLICKUP_GET_FILTERED_TEAM_TASKS
Recupera uma lista paginada de tarefas (até 100 por página) de um workspace com base em critérios de filtro variados, respeitando permissões do usuário. Tarefas inesperadamente ausentes podem indicar restrições de permissão. Não há busca por texto/palavra-chave — filtre no lado do cliente nos resultados retornados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_Id | string | Sim | ID do Workspace (chamado team_id na API v2 do ClickUp). String numérica. |
page | integer | Não | Página a buscar (começa em 0). Incremente até que last_page seja verdadeiro ou a lista retornada esteja vazia. |
statuses | array | Não | Filtro por status — os valores devem corresponder exatamente aos status configurados no workspace. |
assignees | array | Não | Filtro por IDs numéricos de usuários atribuídos. |
list_ids | array | Não | Filtro por IDs numéricos de listas. |
space_ids | array | Não | Filtro por IDs numéricos de espaços. |
project_ids | array | Não | Filtro por IDs numéricos de pastas (projetos). |
due_date_gt | integer | Não | Filtro por data de vencimento maior que este timestamp Unix (milissegundos). |
due_date_lt | integer | Não | Filtro por data de vencimento menor que este timestamp Unix (milissegundos). |
include_closed | boolean | Não | Se verdadeiro, inclui tarefas fechadas. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar comentário à tarefa
Seção intitulada “Adicionar comentário à tarefa”CLICKUP_CREATE_TASK_COMMENT
Adiciona um comentário a uma tarefa do ClickUp.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | Identificador único da tarefa. |
comment_text | string | Sim | Conteúdo do comentário. Suporta formatação ClickUp (menções, markdown). |
assignee | integer | Sim | ID do usuário ao qual o comentário será atribuído. |
notify_all | boolean | Sim | Se verdadeiro, notifica todos os observadores da tarefa, incluindo o criador. |
team_id | string | Não | ID do time — obrigatório se custom_task_ids for verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter comentários da tarefa
Seção intitulada “Obter comentários da tarefa”CLICKUP_GET_TASK_COMMENTS
Recupera até 25 comentários de uma tarefa especificada, com suporte a paginação via start e start_id para buscar comentários mais antigos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | Identificador único da tarefa. |
start | integer | Não | Timestamp Unix (milissegundos) do comentário mais antigo visível, usado com start_id para paginação. |
start_id | string | Não | ID do comentário mais antigo visível, usado com start para paginação. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar lista
Seção intitulada “Criar lista”CLICKUP_CREATE_LIST
Cria uma nova lista dentro de uma pasta existente do ClickUp. Se precisar criar uma lista diretamente em um Espaço (sem pasta), use CLICKUP_CREATE_FOLDERLESS_LIST com space_id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder_id | string | Sim | Identificador numérico único da pasta onde a lista será criada. |
name | string | Sim | Nome para a nova lista. |
content | string | Não | Descrição ou notas da lista. |
assignee | integer | Não | ID numérico do usuário responsável. |
due_date | integer | Não | Data de vencimento como timestamp POSIX em milissegundos. |
priority | integer | Não | Nível de prioridade: 1 (Urgente), 2 (Alta), 3 (Normal), 4 (Baixa). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar lista sem pasta
Seção intitulada “Criar lista sem pasta”CLICKUP_CREATE_FOLDERLESS_LIST
Cria uma nova lista diretamente em um Espaço do ClickUp, sem pertencer a nenhuma pasta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
space_id | string | Sim | Identificador do Espaço onde a lista será criada. |
name | string | Sim | Nome para a nova lista sem pasta. |
content | string | Não | Descrição da lista (texto simples ou markdown). |
due_date | integer | Não | Data de vencimento (timestamp POSIX em milissegundos). |
priority | integer | Não | Nível de prioridade: 1 (Urgente), 2 (Alta), 3 (Normal), 4 (Baixa). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir lista
Seção intitulada “Excluir lista”CLICKUP_DELETE_LIST
Exclui permanentemente uma lista existente e todo o seu conteúdo — ação destrutiva e irreversível via API.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | Identificador numérico único da lista a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar pasta
Seção intitulada “Criar pasta”CLICKUP_CREATE_FOLDER
Cria uma nova pasta dentro do Espaço especificado, que deve existir e ser acessível.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
space_id | string | Sim | ID numérico do Espaço onde a pasta será criada. |
name | string | Sim | Nome da pasta a criar. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Excluir pasta
Seção intitulada “Excluir pasta”CLICKUP_DELETE_FOLDER
Exclui permanente e irreversivelmente uma pasta especificada e todo o seu conteúdo (Listas, Tarefas).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
folder_id | string | Sim | Identificador numérico único da pasta a excluir. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar espaço
Seção intitulada “Criar espaço”CLICKUP_CREATE_SPACE
Cria um novo Espaço dentro de um Workspace especificado, com configuração opcional de funcionalidades que herdam as configurações do workspace se não especificadas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_id | string | Sim | ID numérico do Workspace onde o Espaço será criado. |
name | string | Sim | Nome para o novo Espaço. |
multiple_assignees | boolean | Sim | Habilitar/desabilitar múltiplos responsáveis para tarefas neste Espaço. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Listar espaços
Seção intitulada “Listar espaços”CLICKUP_GET_SPACES
Recupera os Espaços de um Workspace (Team ID). Informações de membros de Espaços privados só são retornadas se o usuário autenticado for membro.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_id | string | Sim | Identificador do Workspace (Team). |
archived | boolean | Não | Filtro por status arquivado (true para arquivados, false para ativos). |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar documento
Seção intitulada “Criar documento”CLICKUP_CREATE_DOC
Cria um novo Doc do ClickUp em um Workspace (API v3 de Docs) e retorna o doc_id para operações de páginas e conteúdo subsequentes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
workspace_id | string | Sim | ID do workspace onde o documento será criado. |
name | string | Sim | Nome/título para o novo documento. |
parent_id | string | Não | ID do local pai (espaço, pasta ou lista) onde o doc deve ser criado. Se omitido, o doc é criado no nível do workspace. |
parent_type | string | Não | Tipo do local pai: space, folder ou list. Obrigatório se parent_id for informado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter conteúdo do documento
Seção intitulada “Obter conteúdo do documento”CLICKUP_GET_DOC_CONTENT
Busca o conteúdo completo de um Doc do ClickUp, incluindo metadados e conteúdo de todas as páginas em formato markdown.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
workspace_id | string | Sim | ID numérico do workspace que contém o documento. |
doc_id | string | Sim | ID único do Doc no formato {prefixo_alfanumérico}-{número} (ex.: 2kz0k9bp-1376). IDs somente numéricos são IDs de View, não de Doc, e falharão. |
page_ids | array | Não | Lista opcional de IDs de páginas específicas a buscar. Se omitida, todas as páginas do doc são recuperadas. |
include_page_listing_only | boolean | Não | Se verdadeiro, retorna apenas a lista de páginas sem o conteúdo, útil para descobrir a estrutura do documento. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Buscar documentos
Seção intitulada “Buscar documentos”CLICKUP_SEARCH_DOCS
Busca e lista metadados de Docs em um workspace do ClickUp. Use após confirmar o ID do workspace para localizar rapidamente documentos relevantes antes de buscar páginas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
workspace_id | string | Sim | ID do Workspace do ClickUp onde os Docs serão listados. |
limit | integer | Não | Máximo de resultados por página. Padrão: 50, máximo: 100. |
cursor | string | Não | Cursor da resposta anterior para buscar a próxima página. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar página em documento
Seção intitulada “Criar página em documento”CLICKUP_CREATE_DOC_PAGE
Cria uma página em um Doc do ClickUp (API v3 de Docs), podendo ser página raiz ou subpágina de uma página pai.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
doc_id | string | Sim | ID do doc no formato {prefixo_alfanumérico}-{número}. |
workspace_id | integer | Sim | ID do Workspace. |
name | string | Não | Nome da nova página. |
content | string | Não | Conteúdo da nova página (markdown ou texto simples, conforme content_format). |
content_format | string | Não | Formato do conteúdo: text/md para markdown (padrão) ou text/plain. |
parent_page_id | string | Não | ID da página pai. Se informado, a nova página é criada como subpágina. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Atualizar página de documento
Seção intitulada “Atualizar página de documento”CLICKUP_CLICK_UP_UPDATE_DOC_PAGE
Atualiza o título e/ou conteúdo de uma página de Doc do ClickUp via API v3 de Docs.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
workspace_id | string | Sim | ID do workspace que contém o documento. |
doc_id | string | Sim | Identificador único do documento que contém a página. |
page_id | string | Sim | Identificador único da página a atualizar. |
name | string | Não | Novo título/nome para a página. Se não informado, o nome não é alterado. |
content | string | Não | Novo conteúdo para a página em formato markdown. Se não informado, o conteúdo não é alterado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Definir valor de campo personalizado
Seção intitulada “Definir valor de campo personalizado”CLICKUP_SET_CUSTOM_FIELD_VALUE
Define ou atualiza o valor de um Campo Personalizado para uma tarefa. A estrutura do valor depende do tipo de campo (texto, número, checkbox, dropdown, data, etc.).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | ID da tarefa a atualizar. |
field_id | string | Sim | UUID do Campo Personalizado a atualizar (formato UUID com hífens). |
value | string | Sim | Valor a definir. A estrutura varia por tipo: texto/número como string, checkbox como boolean, dropdown como UUID de opção, data como timestamp Unix em milissegundos. |
value_options | object | Não | Configurações opcionais para certos tipos de campo (ex.: {'time': true} para datas, {'currency_type': 'USD'} para moeda). |
team_id | string | Não | ID do time — obrigatório se custom_task_ids for verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Iniciar registro de tempo
Seção intitulada “Iniciar registro de tempo”CLICKUP_START_TIME_ENTRY
Inicia um novo registro de tempo (timer) no Workspace especificado, podendo associá-lo a uma tarefa, adicionar descrição e definir se é faturável.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_Id | string | Sim | ID do Workspace (também chamado de Team ID na API do ClickUp). |
tid | string | Não | ID da tarefa a associar ao registro de tempo. |
description | string | Não | Descrição para o registro de tempo. |
billable | boolean | Não | Indica se o registro de tempo é faturável. |
tags | array | Não | Array de objetos de tag (cada um com name, opcionalmente tag_bg e tag_fg). Requer plano Business ou superior. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Parar registro de tempo
Seção intitulada “Parar registro de tempo”CLICKUP_STOP_TIME_ENTRY
Para o registro de tempo ativo atual do usuário autenticado no Workspace especificado. Requer que um registro de tempo esteja em andamento.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_id | string | Sim | Identificador numérico único do Workspace onde o registro de tempo está sendo rastreado. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar registro de tempo
Seção intitulada “Criar registro de tempo”CLICKUP_CREATE_A_TIME_ENTRY
Cria um novo registro de tempo para um time especificado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_Id | string | Sim | ID do Workspace onde o registro de tempo será adicionado. |
start | integer | Sim | Hora de início do registro como timestamp Unix em milissegundos. |
duration | integer | Sim | Duração do registro em milissegundos. Se start e end/stop também forem informados, o servidor recalcula a duração. |
tid | string | Não | ID da tarefa a associar ao registro. |
description | string | Não | Descrição opcional para o registro. |
billable | boolean | Não | Indica se o registro é faturável. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar meta
Seção intitulada “Criar meta”CLICKUP_CREATE_GOAL
Cria uma nova meta em um Workspace do ClickUp.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | Nome da nova meta. |
team_id | string | Sim | ID do Workspace (Team) onde a meta será criada. |
due_date | integer | Não | Data de vencimento como timestamp Unix em milissegundos. |
description | string | Não | Descrição da meta. |
multiple_owners | boolean | Não | Se verdadeiro, permite múltiplos proprietários para a meta. |
owners | array | Não | IDs dos usuários proprietários da meta. |
color | string | Não | Cor da meta em hexadecimal. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter workspaces autorizados
Seção intitulada “Obter workspaces autorizados”CLICKUP_GET_AUTHORIZED_TEAMS_WORKSPACES
Recupera os Workspaces (Teams) acessíveis ao usuário autenticado.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Obter usuário autorizado
Seção intitulada “Obter usuário autorizado”CLICKUP_GET_AUTHORIZED_USER
Retorna as informações do usuário autenticado na conta ClickUp.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Criar tarefa a partir de modelo
Seção intitulada “Criar tarefa a partir de modelo”CLICKUP_CREATE_TASK_FROM_TEMPLATE
Cria uma nova tarefa em uma lista especificada do ClickUp a partir de um modelo de tarefa.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
list_id | string | Sim | ID numérico da lista do ClickUp onde a tarefa será criada. |
template_id | string | Sim | ID único do modelo de tarefa a usar. |
name | string | Sim | Nome para a nova tarefa criada a partir do modelo. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Adicionar tag a tarefa
Seção intitulada “Adicionar tag a tarefa”CLICKUP_ADD_TAG_TO_TASK
Adiciona uma tag existente a uma tarefa especificada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
task_id | string | Sim | ID da tarefa à qual a tag será adicionada. |
tag_name | string | Sim | Nome da tag a adicionar. A tag deve já existir no workspace. |
team_id | integer | Não | ID do time — obrigatório se custom_task_ids for verdadeiro. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |
Convidar usuário para o workspace
Seção intitulada “Convidar usuário para o workspace”CLICKUP_INVITE_USER_TO_WORKSPACE
Convida um usuário para um Workspace do ClickUp pelo endereço de e-mail.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
team_id | integer | Sim | ID do Workspace para o qual o usuário será convidado. |
email | string | Sim | Endereço de e-mail do usuário a convidar. |
admin | boolean | Não | Se verdadeiro, o usuário é convidado como administrador. |
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
data | string | Sim | Dados retornados pela execução da ação. |
error | string | Não | Mensagem de erro caso a execução tenha falhado. |
successful | boolean | Sim | Indica se a ação foi executada com sucesso. |