Notion
Visão geral
Seção intitulada “Visão geral”Notion é uma plataforma de produtividade que centraliza notas, documentos, wikis e tarefas em um único workspace, permitindo que equipes criem fluxos de trabalho personalizados para colaboração e gestão do conhecimento. Com a integração Notion no SquadOS, seus agentes podem criar e editar páginas, gerenciar bancos de dados, buscar conteúdo e automatizar fluxos de trabalho de documentação diretamente no workspace da sua equipe.
- Site oficial: https://www.notion.so/
- Documentação na Composio: docs.composio.dev/toolkits/notion
Autenticação
Seção intitulada “Autenticação”Esta ferramenta suporta OAuth 2.0 (OAUTH2) e chave de API (API_KEY) para conectar.
O modo OAuth 2.0 é recomendado para acesso em nome de usuários. A chave de API (integration token) é usada para integrações internas do Notion, onde o acesso às páginas é controlado manualmente nas configurações da integração.
Você vai precisar dos seguintes campos (para API_KEY):
| Campo | Obrigatório | Descrição |
|---|---|---|
api_key | Sim | Token de integração interna do Notion, gerado nas configurações de integração do workspace. |
Como obter a credencial
Seção intitulada “Como obter a credencial”OAuth 2.0
Seção intitulada “OAuth 2.0”Ao conectar via OAuth, você será redirecionado para a página de autorização do Notion, onde poderá selecionar as páginas e bancos de dados aos quais a integração terá acesso.
Chave de API (integration token)
Seção intitulada “Chave de API (integration token)”- Acesse notion.so e faça login.
- Vá em Configurações e membros → Conexões → Desenvolver ou gerenciar integrações.
- Clique em Nova integração e preencha o nome e as permissões desejadas.
- Copie o Token secreto de integração (começa com
secret_). - Compartilhe as páginas ou bancos de dados desejados com a integração no Notion (botão Conectar em cada página).
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
Notion. - 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 (OAuth) ou informa as credenciais obtidas 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.)
Perguntas frequentes
Seção intitulada “Perguntas frequentes”Por que as operações do Notion mostram “Composio” em vez do nome do usuário?
Seção intitulada “Por que as operações do Notion mostram “Composio” em vez do nome do usuário?”O Notion atribui ações à própria integração, não ao usuário individual. O nome e o logotipo exibidos vêm da configuração da integração. Para usar um nome ou logotipo personalizado, crie sua própria integração no Notion. Consulte a documentação de integrações do Notion.
Como conceder acesso a mais páginas do Notion?
Seção intitulada “Como conceder acesso a mais páginas do Notion?”Abra o Notion, vá em Configurações e membros → Conexões. Selecione a integração (Composio ou sua integração personalizada), clique em “Selecionar páginas” ou “Gerenciar acesso”, e adicione ou remova páginas conforme necessário.
O Notion usa escopos OAuth?
Seção intitulada “O Notion usa escopos OAuth?”Não. O Notion controla o acesso concedendo às integrações acesso a páginas e bancos de dados específicos, não por meio de escopos. Não é necessário passar escopos ao criar uma configuração de autenticação.
Como funciona o modelo de acesso do Notion?
Seção intitulada “Como funciona o modelo de acesso do Notion?”Depende do tipo de integração. Apps OAuth (públicos) permitem que os usuários selecionem quais páginas compartilhar durante a autorização. Integrações internas (chave de API) têm o acesso às páginas gerenciado nas configurações da integração.
Ações disponíveis
Seção intitulada “Ações disponíveis”Adicionar múltiplos blocos de conteúdo (bulk, fácil de usar)
Seção intitulada “Adicionar múltiplos blocos de conteúdo (bulk, fácil de usar)”NOTION_ADD_MULTIPLE_PAGE_CONTENT
Adiciona blocos de conteúdo em lote ao Notion. Textos com mais de 2000 caracteres são divididos automaticamente. Processa formatação markdown. ATENÇÃO — TIPOS DE BLOCO PAI: o conteúdo é adicionado COMO FILHOS de parent_block_id. Para adicionar conteúdo APÓS um cabeçalho, use o ID da PÁGINA como pai e o ID do cabeçalho no parâmetro after. Cabeçalhos NÃO podem ter filhos a menos que is_toggleable=True.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | ID do bloco APÓS o qual inserir o conteúdo (como irmão). Use para adicionar conteúdo após um cabeçalho: defina parent_block_id como o ID da PÁGINA e after como o ID do CABEÇALHO. Se omitido, os blocos são adicionados ao final da lista de filhos do pai. |
content_blocks | array | Sim | Lista de blocos a adicionar (máx. 100). Cada item pode usar o formato simplificado: {'content': 'texto', 'block_property': 'paragraph'} ou o formato completo do Notion. Recursos automáticos: parse de markdown (negrito, itálico, código, link). Valores válidos para block_property: paragraph, heading_1-3, callout, to_do, toggle, quote, bulleted/numbered_list_item, divider. |
parent_block_id | string | Sim | UUID do bloco ou página pai onde o conteúdo será adicionado COMO FILHOS. Erro comum: para adicionar conteúdo APÓS um bloco (como irmão), use o ID da página como parent_block_id e especifique o ID do bloco em after. |
| 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 bloco único de conteúdo a página Notion (Depreciado)
Seção intitulada “Adicionar bloco único de conteúdo a página Notion (Depreciado)”NOTION_ADD_PAGE_CONTENT
DEPRECIADO: Use add_multiple_page_content para melhor desempenho. Adiciona um único bloco de conteúdo a uma página ou bloco do Notion. O campo content é obrigatório para blocos de texto. O limite de 2000 caracteres por campo text.content é aplicado automaticamente (conteúdo acima do limite é dividido em múltiplos blocos).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | Identificador de um bloco existente. O novo bloco de conteúdo será adicionado imediatamente após este bloco. Se omitido, é adicionado ao final da lista de filhos do pai. |
content_block | string | Sim | Formato simplificado: {'content': 'texto', 'block_property': 'tipo'}. O campo content é obrigatório para: paragraph, heading_1-3, callout, to_do, toggle, quote, bulleted_list_item, numbered_list_item. Máx. 2000 caracteres por campo de conteúdo. Também aceita formato completo de bloco do Notion. |
parent_block_id | string | Sim | Identificador da página ou bloco pai ao qual o novo bloco será adicionado. O pai deve ser: Página, Toggle, To-do, Item de lista ou Callout. Também aceita os aliases page_id ou block_id. |
| 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. |
Anexar blocos brutos do Notion (API avançada)
Seção intitulada “Anexar blocos brutos do Notion (API avançada)”NOTION_APPEND_BLOCK_CHILDREN
DEPRECIADO: Use NOTION_APPEND_TEXT_BLOCKS, NOTION_APPEND_TASK_BLOCKS, NOTION_APPEND_CODE_BLOCKS, NOTION_APPEND_MEDIA_BLOCKS, NOTION_APPEND_LAYOUT_BLOCKS ou NOTION_APPEND_TABLE_BLOCKS. Anexa blocos brutos da API Notion ao pai. Texto limitado a 2000 caracteres por campo text.content. Cada bloco DEVE ter object: 'block' e type.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | Identificador único (UUID) do bloco ou página pai ao qual os filhos serão anexados. |
children | array | Sim | Array de objetos de bloco (máx. 100 por requisição). Limite de 2000 caracteres por campo text.content. Cada bloco DEVE incluir: object: 'block' e type. Blocos de texto devem usar a estrutura rich_text. |
| 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. |
Anexar blocos de código (code, quote, equation)
Seção intitulada “Anexar blocos de código (code, quote, equation)”NOTION_APPEND_CODE_BLOCKS
Anexa blocos de código e técnicos (code, quote, equation) a uma página do Notion. Use para: trechos de código e exemplos de programação (code); citações destacadas (quote); fórmulas matemáticas e equações (equation). O conteúdo de código é limitado a 2000 caracteres por campo text.content.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | UUID do bloco ou página pai ao qual os filhos serão anexados. |
children | array | Sim | Array de objetos de bloco de código/técnicos. Tipos suportados: code (com destaque de sintaxe, mais de 70 linguagens), quote (citação em bloco), equation (equação matemática em LaTeX/KaTeX). Máx. 100 blocos por requisiçã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. |
Anexar blocos de layout (divider, TOC, colunas)
Seção intitulada “Anexar blocos de layout (divider, TOC, colunas)”NOTION_APPEND_LAYOUT_BLOCKS
Anexa blocos de layout (divider, TOC, breadcrumb, colunas) a uma página do Notion. Tipos suportados: divider (separador horizontal), table_of_contents (gerado automaticamente a partir dos cabeçalhos), breadcrumb (navegação de hierarquia), column_list (layout multi-colunas, exige 2+ colunas, cada uma com 1+ bloco filho).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | UUID do bloco ou página pai ao qual os filhos serão anexados. |
children | array | Sim | Array de objetos de bloco de layout/estruturais. Tipos: divider, table_of_contents, breadcrumb, column_list (exige pelo menos 2 colunas, cada uma com pelo menos 1 bloco filho), column. Blocos column_list devem incluir seus filhos de coluna na mesma requisição. Máx. 100 blocos por requisiçã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. |
Anexar blocos de mídia (image, video, audio, files)
Seção intitulada “Anexar blocos de mídia (image, video, audio, files)”NOTION_APPEND_MEDIA_BLOCKS
Anexa blocos de mídia (image, video, audio, file, pdf, embed, bookmark) a uma página do Notion. Use para: imagens e capturas de tela (image); vídeos do YouTube/Vimeo ou URLs diretas (video); arquivos de áudio (audio); downloads de arquivos (file); documentos PDF (pdf); conteúdo incorporado do Twitter, Figma, CodePen etc. (embed); pré-visualizações de links (bookmark). Todos os blocos de mídia exigem URLs externas.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | UUID do bloco ou página pai ao qual os filhos serão anexados. |
children | array | Sim | Array de objetos de bloco de mídia. Tipos suportados: image, video, audio, file, pdf, embed, bookmark. Todos os tipos de mídia exigem uma URL externa. Máx. 100 blocos por requisiçã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. |
Anexar blocos de tabela
Seção intitulada “Anexar blocos de tabela”NOTION_APPEND_TABLE_BLOCKS
Anexa blocos de tabela a uma página do Notion. Use para dados tabulares estruturados como planilhas, tabelas de comparação e rastreadores de status. O conteúdo de célula é limitado a 2000 caracteres por campo text.content.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
tables | array | Sim | Array de tabelas a anexar. Cada tabela inclui: table_width (número de colunas, 1-100), has_column_header (estilizar primeira linha como cabeçalho, padrão false), has_row_header (estilizar primeira coluna como cabeçalho, padrão false), rows (array de objetos de linha, ao menos um obrigatório). Cada linha contém um array cells onde cada célula é um array de objetos de rich text. O número de células em cada linha DEVE corresponder a table_width. Máx. 100 tabelas por requisição. |
block_id | string | Sim | UUID do bloco ou página pai ao qual os filhos serão anexados. |
| 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. |
Anexar blocos de tarefa (to-do, toggle, callout)
Seção intitulada “Anexar blocos de tarefa (to-do, toggle, callout)”NOTION_APPEND_TASK_BLOCKS
Anexa blocos de tarefa (to-do, toggle, callout) a uma página ou bloco do Notion. Tipos suportados: to_do (itens com caixa de seleção), toggle (seções recolhíveis), callout (caixas destacadas com ícone emoji). Todos os três tipos suportam filhos aninhados (até 2 níveis de aninhamento). Limite: 2000 caracteres por text.content, máx. 100 blocos por requisição.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | UUID da página ou bloco pai. Deve ser uma página ou tipo de bloco que suporte filhos (ex.: page, toggle, paragraph, list items, quote, callout, to_do). Tipos como divider, breadcrumb e equation NÃO suportam filhos. |
children | array | Sim | Array de objetos de bloco de tarefa/interativos. Tipos: to_do (tarefa com checkbox), toggle (seção recolhível), callout (caixa destacada com ícone emoji). Máx. 2 níveis de aninhamento. Máx. 100 blocos por requisiçã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. |
Anexar blocos de texto (parágrafos, cabeçalhos, listas)
Seção intitulada “Anexar blocos de texto (parágrafos, cabeçalhos, listas)”NOTION_APPEND_TEXT_BLOCKS
Anexa blocos de texto (parágrafos, cabeçalhos, listas) a uma página do Notion. É a ação mais usada para adicionar conteúdo ao Notion. Use para: documentação, notas, artigos, esboços, listas. Tipos suportados: paragraph, heading_1/2/3, bulleted_list_item, numbered_list_item. Limite de 2000 caracteres por campo text.content.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
after | string | Não | UUID opcional de um bloco filho existente. Os novos blocos serão inseridos após este bloco. |
block_id | string | Sim | UUID do bloco ou página pai ao qual os filhos serão anexados. |
children | array | Sim | Array de objetos de bloco de texto (também aceita blocks como nome do parâmetro). Tipos: paragraph, heading_1/2/3, bulleted_list_item, numbered_list_item. Limite de 2000 caracteres por text.content. Máx. 100 blocos por requisiçã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. |
Arquivar página do Notion
Seção intitulada “Arquivar página do Notion”NOTION_ARCHIVE_NOTION_PAGE
Arquiva (move para a lixeira) ou desarquiva (restaura da lixeira) uma página do Notion especificada. Limitação: páginas no nível do workspace (páginas de nível superior sem página pai ou banco de dados) não podem ser arquivadas via API — devem ser arquivadas manualmente na interface do Notion.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
archive | boolean | Não | Defina como true para mover a página para a lixeira (arquivar), ou false para restaurá-la (desarquivar). Padrão: true. |
page_id | string | Sim | Identificador único (UUID) da página do Notion a ser arquivada ou desarquivada. Deve ser um ID de página, não de banco de dados. |
| 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 comentário
Seção intitulada “Criar comentário”NOTION_CREATE_COMMENT
Adiciona um comentário a uma página do Notion (via parent_page_id) OU a um tópico de discussão existente (via discussion_id). Não é possível criar novos tópicos de discussão em blocos específicos (comentários inline).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
comment | object | Sim | Conteúdo do comentário como objeto NotionRichText ou string JSON. Forma mais simples: {'content': 'Ficou ótimo!'}. O campo link é apenas para URLs externas, NÃO para IDs de página. |
discussion_id | string | Não | ID de um tópico de discussão existente ao qual o comentário será adicionado. Obrigatório se parent_page_id não for fornecido. |
parent_page_id | string | Não | ID da página do Notion onde o comentário será adicionado. Obrigatório se discussion_id não for fornecido. |
| 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 banco de dados no Notion
Seção intitulada “Criar banco de dados no Notion”NOTION_CREATE_DATABASE
Cria um novo banco de dados do Notion como subpágina de uma página pai especificada, com um esquema de propriedades definido. IMPORTANTE: a página pai DEVE estar compartilhada com sua integração. Para propriedades do tipo relation, você DEVE fornecer o database_id do banco de dados relacionado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Título desejado para o novo banco de dados. |
parent_id | string | Sim | DEVE SER UM ID DE PÁGINA, NÃO DE BANCO DE DADOS. Bancos de dados só podem ser criados como filhos de páginas. Use NOTION_SEARCH_NOTION_PAGE com filter_value='page' para encontrar páginas válidas. UUID com ou sem hífens. A página deve estar compartilhada com sua integração. |
properties | array | Não | Lista opcional definindo o esquema (colunas) para o novo banco de dados. Cada item é um objeto com name e type. Se não fornecido, o Notion cria um banco de dados padrão com uma única coluna Name do tipo title. A lista deve incluir ao menos uma propriedade do tipo title. |
| 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 upload de arquivo no Notion
Seção intitulada “Criar upload de arquivo no Notion”NOTION_CREATE_FILE_UPLOAD
Cria um objeto FileUpload no Notion e obtém uma URL de upload. Use quando precisar automatizar a anexação de arquivos locais ou externos diretamente no Notion sem hospedagem externa.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
mode | string | Não | Modo de upload: single_part para upload direto (padrão, até 20 MB), multi_part para uploads fracionados (exige workspace pago do Notion), ou external_url para importar de uma URL pública. Workspaces gratuitos são limitados a 5 MB e não podem usar o modo multi_part. |
filename | string | Não | Nome do arquivo legível com extensão. Obrigatório para external_url. |
content_type | string | Não | Tipo MIME do arquivo. Obrigatório em multi_part se o filename não tiver extensão. |
external_url | string | Não | URL pública HTTPS para importar. Obrigatório quando mode='external_url'. |
number_of_parts | integer | Não | Total de partes para upload multi-part; obrigatório quando mode='multi_part'. |
| 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 no Notion
Seção intitulada “Criar página no Notion”NOTION_CREATE_NOTION_PAGE
Cria uma nova página em um workspace do Notion sob uma página ou banco de dados pai especificado. Suporta criação de páginas com conteúdo markdown usando o parâmetro markdown, ou como página vazia para popular depois. PRÉ-REQUISITOS: a página/banco de dados pai deve existir e estar acessível no workspace. O parâmetro markdown é mutuamente exclusivo com children/content.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
icon | string | Não | Emoji para usar como ícone da nova página. Deve ser um único emoji. |
cover | string | Não | URL de uma imagem para usar como capa da nova página. A URL deve ser publicamente acessível. |
title | string | Sim | Título da nova página a ser criada. |
markdown | string | Não | Conteúdo da página em Markdown estilo Notion. Se fornecido, a página será criada a partir desta string markdown. O primeiro cabeçalho # h1 será extraído como título da página se properties.title for omitido. |
parent_id | string | Sim | UUID válido do Notion em formato com hífens ou sem hífens de uma página ou banco de dados existente. Sempre use search_pages ou list_databases primeiro para obter IDs válidos. Também aceita parent_page_id como alias. |
| 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 um bloco
Seção intitulada “Excluir um bloco”NOTION_DELETE_BLOCK
Arquiva um bloco, página ou banco de dados do Notion usando seu ID, definindo a propriedade archived como true (equivale a mover para “Lixeira” na interface). A operação falhará se o bloco tiver um pai ou ancestral arquivado na hierarquia. LIMITAÇÃO: páginas de nível do workspace não podem ser arquivadas via API.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
block_id | string | Sim | Identificador do bloco, página ou banco de dados a ser excluído (arquivado). UUID válido do Notion, com ou sem hífens. |
| 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. |
Duplicar página
Seção intitulada “Duplicar página”NOTION_DUPLICATE_PAGE
Duplica uma página do Notion, incluindo todo o seu conteúdo, propriedades e blocos aninhados, sob uma página pai ou workspace especificado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Não | Novo título opcional para a página duplicada. Se não fornecido, usa o título da página original com o prefixo “Copy of”. |
page_id | string | Sim | Identificador único (UUID v4) da página do Notion a ser duplicada. |
parent_id | string | Sim | Identificador único (UUID v4) da página ou banco de dados que servirá como pai da página duplicada. Não pode ser o mesmo que page_id. |
| 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 todos os conteúdos de bloco do Notion
Seção intitulada “Buscar todos os conteúdos de bloco do Notion”NOTION_FETCH_ALL_BLOCK_CONTENTS
Busca todos os blocos filhos para um determinado bloco do Notion. Use quando precisar de uma listagem completa dos filhos de um bloco além de uma única página; suporta expansão recursiva opcional de blocos aninhados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
block_id | string | Não | Identificador (UUID) do bloco ou página pai do Notion cujos filhos serão listados. Aceita UUIDs com ou sem hífens. Deve ser fornecido block_id ou page_url. |
page_url | string | Não | URL de página do Notion da qual extrair o ID. NOTA: URLs de visualização de banco de dados (com parâmetro ?v=) NÃO são suportadas. Para acessar conteúdo de banco de dados, use NOTION_QUERY_DATABASE. |
max_depth | integer | Não | Profundidade máxima de recursão quando recursive=true. Padrão: 10. |
page_size | integer | Não | Máximo de blocos filhos a retornar por requisição. Padrão e máximo: 100. |
recursive | boolean | Não | Se true, busca filhos aninhados para blocos com has_children=true, adicionando todos os descendentes à lista de saída. |
max_blocks | integer | Não | Máximo total de blocos a retornar quando recursive=true. Padrão: 5000. |
| 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 filhos de bloco do Notion
Seção intitulada “Buscar filhos de bloco do Notion”NOTION_FETCH_BLOCK_CONTENTS
Recupera uma lista paginada de blocos filhos diretos de primeiro nível junto com seus conteúdos para um dado ID de bloco ou página pai do Notion. Use os IDs de bloco da resposta para chamadas subsequentes a conteúdo profundamente aninhado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
block_id | string | Sim | UUID do bloco ou página pai do Notion cujos filhos serão buscados. Aceita formatos com e sem hífens. |
page_size | integer | Não | Número máximo de blocos filhos a retornar em uma única resposta. Máximo: 100. |
start_cursor | string | Não | Cursor de paginação do next_cursor em uma resposta anterior da API. |
| 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 metadados de bloco do Notion
Seção intitulada “Buscar metadados de bloco do Notion”NOTION_FETCH_BLOCK_METADATA
Busca metadados de um bloco do Notion (incluindo páginas, que são blocos especiais) usando seu UUID. Retorna tipo de bloco, propriedades e informações básicas, mas não o conteúdo filho. Para blocos filhos, use fetch_block_contents.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
block_id | string | Sim | Identificador UUID único para o bloco do Notion a ser recuperado. Deve ser um UUID válido de 32 caracteres (com ou sem hífens). |
| 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 comentários
Seção intitulada “Buscar comentários”NOTION_FETCH_COMMENTS
Busca comentários não resolvidos para um ID de bloco ou página do Notion especificado. O bloco/página deve estar compartilhado com sua integração do Notion e a integração deve ter a capacidade “Read comments” habilitada.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_id | string | Não | Identificador de uma página do Notion da qual buscar comentários. Alias para block_id. Forneça page_id ou block_id, mas não ambos. |
block_id | string | Não | Identificador de um bloco do Notion do qual buscar comentários. Forneça block_id ou page_id, mas não ambos. |
page_size | integer | Não | Número de comentários a retornar por página de resposta. Entre 1 e 100. Padrão: 100. |
start_cursor | string | Não | Cursor de paginação. Se fornecido, a resposta conterá a página de resultados após este cursor. |
| 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 dados do Notion
Seção intitulada “Buscar dados do Notion”NOTION_FETCH_DATA
Busca itens do Notion (páginas e/ou bancos de dados) no workspace do Notion. Use para obter dados mínimos sobre os itens no workspace com uma consulta ou listar todos os itens com dados mínimos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Consulta de busca opcional para filtrar páginas e/ou bancos de dados pelo título ou conteúdo. Se não fornecido, todos os itens acessíveis correspondentes ao tipo selecionado são retornados. |
page_size | integer | Não | Número máximo de itens por página (1-100). O máximo da API do Notion é 100 — valores acima serão automaticamente limitados a 100. Padrão: 100. |
fetch_type | string | Sim | Especifica o tipo de dado do Notion a buscar: pages (apenas páginas), databases (apenas bancos de dados) ou all (ambos). |
start_cursor | string | Não | Cursor de paginação para buscar a próxima página de resultados. |
original_page_size | integer | Não | Valor original do tamanho de página antes de ser limitado. |
page_size_was_capped | boolean | Não | Indica se o tamanho de página foi limitado ao valor máximo permitido. |
| 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 banco de dados
Seção intitulada “Buscar banco de dados”NOTION_FETCH_DATABASE
Busca os metadados estruturais de um banco de dados do Notion (propriedades, título etc.) via database_id, não as entradas de dados. O database_id deve referenciar um banco de dados existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
database_id | string | Sim | Identificador único do banco de dados do Notion em formato UUID. Deve ser um ID de BANCO DE DADOS, não um ID de página. Para encontrar IDs de banco de dados, use NOTION_SEARCH_NOTION_PAGE com filter_value='database'. |
| 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 linha do banco de dados
Seção intitulada “Buscar linha do banco de dados”NOTION_FETCH_ROW
Recupera as propriedades e metadados de uma linha de banco de dados do Notion. Use fetch_block_contents para blocos de conteúdo da página.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_id | string | Sim | UUID da página do Notion (que representa uma linha no banco de dados) a ser recuperada. Deve ser um ID de página, não de banco de dados. Use NOTION_FETCH_DATA ou NOTION_QUERY_DATABASE para obter IDs de página de bancos de dados. |
| 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 sobre mim (Depreciado)
Seção intitulada “Obter sobre mim (Depreciado)”NOTION_GET_ABOUT_ME
DEPRECIADO: Use GetAboutUser. Recupera o objeto User para o bot associado ao token de integração do Notion atual, normalmente para obter o ID de usuário do bot para outras operações da API.
| 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 sobre usuário
Seção intitulada “Obter sobre usuário”NOTION_GET_ABOUT_USER
Recupera informações detalhadas sobre um usuário específico do Notion, como nome, avatar e e-mail, com base em seu ID de usuário único.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Sim | Identificador único do usuário do Notion cujos detalhes devem ser recuperados. |
| 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 markdown da página
Seção intitulada “Obter markdown da página”NOTION_GET_PAGE_MARKDOWN
Recupera o conteúdo completo de uma página do Notion renderizado como Markdown estilo Notion em uma única chamada de API. Use quando precisar do conteúdo legível de uma página sem busca recursiva de blocos filhos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_id | string | Sim | UUID da página do Notion a ser recuperada como markdown. Aceita formatos UUID com hífens (8-4-4-4-12) e sem hífens (32 caracteres). IMPORTANTE: apenas IDs de página são aceitos — IDs de banco de dados serão rejeitados. |
include_transcript | boolean | Não | Defina como true para incluir transcrições de notas de reunião na resposta markdown. Padrão: false. |
| 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 propriedade de página
Seção intitulada “Obter propriedade de página”NOTION_GET_PAGE_PROPERTY_ACTION
Chame esta ação para obter uma propriedade específica de uma página do Notion quando tiver um page_id e um property_id válidos. Lida com paginação para propriedades que retornam múltiplos itens.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_id | string | Sim | Identificador da página do Notion da qual recuperar a propriedade. |
page_size | integer | Não | Para tipos de propriedade paginados (ex.: relation, rollup, rich_text), especifica o número de itens a retornar por requisição. |
property_id | string | Sim | Identificador ou nome da propriedade a recuperar. Para propriedades de title, o ID é sempre title. Para outras propriedades, pode ser o nome exibido no Notion (ex.: Status, Assignee) ou seu ID programático único. |
start_cursor | string | Não | Para propriedades paginadas, se uma resposta anterior indicou has_more: true, forneça o valor next_cursor aqui para buscar o próximo conjunto de itens. |
| 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. |
Inserir linha no banco de dados
Seção intitulada “Inserir linha no banco de dados”NOTION_INSERT_ROW_DATABASE
Cria uma nova página (linha) em um banco de dados do Notion especificado. PRÉ-REQUISITOS: o banco de dados deve estar compartilhado com sua integração; os nomes E tipos de propriedade devem corresponder exatamente ao esquema (case-sensitive). Erros comuns: 404 (banco de dados não compartilhado), 400 “not a property” (nome de propriedade errado), 400 “expected to be X” (tipo de propriedade errado).
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
icon | string | Não | Emoji para usar como ícone da página. Deve ser um único emoji. |
cover | string | Não | URL de uma imagem externa para usar como capa da página. |
properties | array | Não | Valores de propriedade para a nova página. Aceita uma LISTA de objetos ou string JSON. Cada objeto deve incluir: name (nome exato, case-sensitive), type (tipo de dado) e value (valor como string). Cada banco de dados tem exatamente uma propriedade do tipo title; outros campos de texto usam rich_text. Use NOTION_FETCH_DATA com fetch_type='databases' para encontrar nomes e tipos exatos. |
database_id | string | Sim | Identificador (UUID) do banco de dados do Notion onde a nova página (linha) será inserida. |
child_blocks | array | Não | Lista de objetos NotionRichText definindo blocos de conteúdo a anexar ao corpo da nova 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. |
Inserir linha a partir de linguagem natural
Seção intitulada “Inserir linha a partir de linguagem natural”NOTION_INSERT_ROW_FROM_NL
Cria uma nova linha (página) em um banco de dados do Notion a partir de uma descrição em linguagem natural. Busca o esquema do banco de dados em tempo de execução, usa um LLM para gerar o payload de propriedades formatado corretamente e cria a página.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
icon | string | Não | Emoji opcional para usar como ícone da página. |
cover | string | Não | URL opcional de imagem de capa para a página. |
nl_query | string | Sim | Descrição em linguagem natural da linha a criar. Exemplo: “Adicionar tarefa: Revisar PR #14143, prioridade Alta, status Em andamento, prazo amanhã”. |
database_id | string | Sim | UUID do banco de dados do Notion onde a nova linha será inserida. |
| 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 templates de fonte de dados
Seção intitulada “Listar templates de fonte de dados”NOTION_LIST_DATA_SOURCE_TEMPLATES
Lista todos os templates de uma fonte de dados do Notion. Use quando precisar descobrir IDs/nomes de templates para criação em lote de páginas. Use após confirmar o data_source_id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_size | integer | Não | Número de templates a retornar por página (1-100). Padrão: 100. |
start_cursor | string | Não | Cursor para paginação. Use o valor next_cursor de uma resposta anterior. |
data_source_id | string | Sim | ID da fonte de dados (UUIDv4). Parâmetro de caminho que identifica a fonte de dados da qual listar templates. |
| 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 uploads de arquivos do Notion
Seção intitulada “Listar uploads de arquivos do Notion”NOTION_LIST_FILE_UPLOADS
Recupera os uploads de arquivo para a integração de bot atual, ordenados do mais recente para o mais antigo. Use quando precisar listar todos os uploads de arquivo ou paginar pelo histórico de uploads.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_size | integer | Não | Controla quantos itens a resposta inclui da lista completa. Máximo 100, padrão 100. |
start_cursor | string | Não | Aceita o valor next_cursor de uma resposta anterior. |
| 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 usuários
Seção intitulada “Listar usuários”NOTION_LIST_USERS
Recupera uma lista paginada de usuários (excluindo convidados) do workspace do Notion. O número de usuários retornados por página pode ser menor que o page_size solicitado.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_size | integer | Não | Número desejado de usuários a recuperar por página. Valor máximo: 100. |
start_cursor | string | Não | Se omitido, recupera a primeira página de usuários. Use o valor next_cursor de uma resposta anterior para obter 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. |
Mover página
Seção intitulada “Mover página”NOTION_MOVE_PAGE
Move uma página do Notion para um novo pai (página ou banco de dados). IMPORTANTE: para mover para um banco de dados, use data_source_id (NÃO database_id). Obtenha o ID da fonte de dados a partir do objeto de banco de dados usando NOTION_FETCH_DATABASE.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
parent | string | Sim | Destino pai para a página. Use type='page_id' com page_id para mover sob outra página. Use type='data_source_id' com data_source_id para mover para um banco de dados. Erro comum: usar type='page_id' com um ID de banco de dados vai falhar. |
page_id | string | Sim | ID da página a mover. Formato UUID com ou sem hífens. |
| 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. |
Consultar banco de dados
Seção intitulada “Consultar banco de dados”NOTION_QUERY_DATABASE
Consulta um banco de dados do Notion para recuperar páginas (linhas). Em um banco de dados do Notion, cada linha é uma página e as colunas são propriedades. Retorna resultados paginados com metadados. O banco de dados deve estar compartilhado com sua integração.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sorts | array | Não | Lista de regras de ordenação para os resultados. Cada regra deve especificar property_name (nome da propriedade do banco de dados ou campo de timestamp) e ascending (true/false). |
page_size | integer | Não | Número de itens a retornar por requisição. Entre 1 e 100. Padrão: 100. |
database_id | string | Sim | UUID do banco de dados do Notion a consultar. Deve ser um ID de BANCO DE DADOS, não um ID de página. |
start_cursor | string | Não | Cursor de paginação para buscar a próxima página de 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. |
Consultar banco de dados com filtro
Seção intitulada “Consultar banco de dados com filtro”NOTION_QUERY_DATABASE_WITH_FILTER
Consulta um banco de dados do Notion com filtragem, ordenação e paginação no lado do servidor. Use quando precisar recuperar um subconjunto de linhas por propriedade, data, status ou outras condições.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sorts | array | Não | Lista de critérios de ordenação em ordem de precedência. Use PropertySort para propriedades do banco de dados e TimestampSort para timestamps do sistema (created_time ou last_edited_time). |
filter | object | Não | Objeto de filtro para limitar os registros retornados. PRÉ-REQUISITO: chame NOTION_FETCH_DATABASE primeiro para descobrir nomes e tipos de propriedade. Suporta filtros de propriedade única ou filtros compostos usando and/or. Os valores de SELECT/STATUS/MULTI_SELECT são case-sensitive e devem corresponder EXATAMENTE às opções definidas no esquema do banco de dados. |
page_size | integer | Não | Número máximo de itens a retornar (1-100). Padrão: 100. |
database_id | string | Sim | UUID do banco de dados do Notion a consultar. Deve ser um ID de BANCO DE DADOS, não um ID de página. |
start_cursor | string | Não | Cursor de uma resposta anterior para buscar a próxima página. |
composio_execution_message | string | Não | Mensagem interna sobre conversões automáticas realizadas durante a execuçã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. |
Consultar fonte de dados
Seção intitulada “Consultar fonte de dados”NOTION_QUERY_DATA_SOURCE
Consulta uma fonte de dados do Notion. Use quando precisar recuperar páginas ou fontes de dados filhas com filtros, ordenações e paginação. Faça requisições paginadas usando cursores e filtros opcionais de propriedades para recuperação eficiente de dados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
sorts | array | Não | Lista de critérios de ordenação em ordem de precedência. Use PropertySort para campos de propriedade ou TimestampSort para tempos de criação/edição. |
filter | object | Não | Objeto de filtro para limitar as entradas retornadas. Suporta filtros de propriedade única ou compostos usando and/or. |
page_size | integer | Não | Número máximo de itens a retornar (1-100). Padrão: 100. |
start_cursor | string | Não | Cursor de uma resposta anterior para buscar a próxima página. |
data_source_id | string | Sim | UUID da fonte de dados do Notion a consultar (com ou sem hífens). |
filter_properties | array | Não | Lista de IDs de propriedade a incluir em cada item retornado. |
| 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. |
Substituir conteúdo da página (com backup)
Seção intitulada “Substituir conteúdo da página (com backup)”NOTION_REPLACE_PAGE_CONTENT
Substitui os blocos filhos de uma página de forma segura, opcionalmente fazendo backup do conteúdo atual, excluindo os filhos existentes e então adicionando novos filhos em lotes. Use quando precisar reconstruir uma página sem deixar estados parciais.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
dry_run | boolean | Não | Se true, retorna o que seria excluído e adicionado sem fazer nenhuma alteração. Use para pré-visualizar a operação. |
page_id | string | Sim | Identificador único (UUID) da página cujo conteúdo será substituído. |
new_children | array | Sim | Array de objetos de bloco a adicionar à página após limpar o conteúdo existente. Blocos serão adicionados em lotes de até 100. |
backup_parent | object | Não | Especificação de pai para criação da página de backup. |
create_backup | boolean | Não | Se deve criar uma página de backup com o conteúdo atual antes de substituir. Fortemente recomendado ao substituir conteúdo importante. |
backup_title_suffix | string | Não | Sufixo a adicionar ao título da página original ao criar uma página de backup. |
archive_existing_children | boolean | Não | Se deve excluir (arquivar) os blocos filhos existentes antes de adicionar novo conteúdo. Defina como false para manter o conteúdo existente e apenas adicionar novos blocos. |
| 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. |
Recuperar comentário
Seção intitulada “Recuperar comentário”NOTION_RETRIEVE_COMMENT
Recupera um comentário específico pelo seu ID. Use quando tiver um ID de comentário e precisar buscar seus detalhes.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
comment_id | string | Sim | Identificador do comentário a recuperar. |
| 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. |
Recuperar propriedade do banco de dados
Seção intitulada “Recuperar propriedade do banco de dados”NOTION_RETRIEVE_DATABASE_PROPERTY
Recupera um objeto de propriedade específico de um banco de dados do Notion. Use quando precisar obter detalhes sobre uma única coluna/propriedade do banco de dados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
database_id | string | Sim | Identificador do banco de dados. |
property_id | string | Sim | Identificador ou nome da propriedade. Pode ser o ID da propriedade (ex.: GZtn) ou o nome (ex.: Status). Suporta valores codificados em URL. O nome da propriedade é case-sensitive. |
| 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. |
Recuperar upload de arquivo do Notion
Seção intitulada “Recuperar upload de arquivo do Notion”NOTION_RETRIEVE_FILE_UPLOAD
Recupera detalhes de um objeto File Upload do Notion pelo seu identificador. Use quando precisar verificar o status ou detalhes de um upload de arquivo existente.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file_upload_id | string | Sim | O identificador único (UUID) do upload de arquivo a recuperar. |
| 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. |
Recuperar página
Seção intitulada “Recuperar página”NOTION_RETRIEVE_PAGE
Recupera as propriedades/metadados (não o conteúdo de bloco) de uma página do Notion pelo page_id. Use quando tiver uma URL/ID de página e precisar acessar suas propriedades. Para conteúdo da página, use as ferramentas de blocos filhos.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
page_id | string | Sim | UUID da página do Notion a recuperar. Aceita formatos com hífens (8-4-4-4-12) e sem hífens (32 caracteres). IMPORTANTE: deve ser um ID de PÁGINA, não de banco de dados. Para páginas com propriedades contendo mais de 25 referências, use NOTION_GET_PAGE_PROPERTY_ACTION para recuperar valores completos. |
| 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. |
Pesquisar páginas e bancos de dados do Notion
Seção intitulada “Pesquisar páginas e bancos de dados do Notion”NOTION_SEARCH_NOTION_PAGE
Pesquisa páginas e bancos de dados do Notion por título. LIMITAÇÕES CONHECIDAS: (1) A indexação de busca não é imediata — itens recém-compartilhados podem não aparecer. (2) A busca não é exaustiva. (3) Páginas de banco de dados retornam todas as propriedades personalizadas — use filter_properties para reduzir o tamanho da resposta.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
query | string | Não | Texto para pesquisar em títulos de páginas e bancos de dados. Se vazio, lista todos os itens acessíveis. |
direction | string | Não | Direção de ordenação dos resultados. Obrigatório se timestamp for fornecido. Valores válidos: ascending ou descending. |
page_size | integer | Não | Número de itens a incluir na resposta. Entre 1 e 100. Padrão: 25. |
timestamp | string | Não | Campo de timestamp pelo qual ordenar os resultados. Atualmente o único valor suportado é last_edited_time. |
filter_value | string | Não | Filtra resultados por tipo de objeto: page ou database. |
start_cursor | string | Não | Cursor opaco do campo next_cursor de uma resposta anterior. |
filter_property | string | Não | Propriedade pela qual filtrar os resultados de busca. Atualmente o único valor suportado é object. |
filter_properties | array | Não | Lista de nomes de propriedades a incluir na resposta para resultados de página. Útil para bancos de dados com muitas propriedades personalizadas. |
| 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. |
Enviar upload de arquivo
Seção intitulada “Enviar upload de arquivo”NOTION_SEND_FILE_UPLOAD
Transmite o conteúdo do arquivo ao Notion para um objeto de upload de arquivo. Use após criar um objeto de upload de arquivo para enviar os dados reais do arquivo.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
file | object | Sim | Informações do arquivo incluindo nome e mimetype. Objeto FileInfo onde name é o nome do arquivo (ex.: document.pdf, test.txt). |
part_number | integer | Não | Obrigatório quando o modo de upload do arquivo é multi_part. Indica qual parte está sendo enviada (numeradas a partir de 1). Para uploads de parte única, omita. |
file_upload_id | string | Sim | Identificador do objeto de upload de arquivo para o qual enviar dados. Obtido da ação Criar Upload de Arquivo. |
file_content_base64 | string | Não | Conteúdo do arquivo opcional codificado em base64. Se fornecido, será usado em vez de baixar do S3 ou ler do file_path. |
| 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 bloco
Seção intitulada “Atualizar bloco”NOTION_UPDATE_BLOCK
Atualiza o conteúdo de texto de um bloco existente do Notion. ATENÇÃO: Conteúdo limitado a 2000 caracteres. Não é possível alterar o tipo do bloco ou arquivá-lo. Para conteúdo maior, divida em múltiplos blocos usando add_multiple_page_content.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
content | string | Sim | Novo conteúdo de texto para o bloco. Substitui o conteúdo de texto existente completamente. ATENÇÃO: limite de 2000 caracteres por campo text.content. |
block_id | string | Sim | Identificador do bloco do Notion a ser atualizado. UUID válido (com ou sem hífens). |
language | string | Não | Linguagem de programação para blocos de código. Obrigatório quando block_type='code'. |
block_type | string | Não | Tipo do bloco sendo atualizado. Se não fornecido, o tipo será detectado automaticamente (adiciona 1 chamada de API extra). Deve corresponder ao tipo EXISTENTE — não é possível alterar o tipo de um bloco. |
additional_properties | object | Não | Dicionário opcional de propriedades específicas do tipo. Exemplos: checked (boolean) para blocos to_do, color para estilização de texto, is_toggleable para blocos de cabeçalho recolhíveis. |
| 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
Seção intitulada “Atualizar página”NOTION_UPDATE_PAGE
Atualiza propriedades, ícone, capa ou status de arquivamento de uma página. IMPORTANTE: os nomes de propriedades são específicos do workspace e case-sensitive. Use NOTION_FETCH_ROW ou NOTION_FETCH_DATABASE primeiro para descobrir os nomes exatos de propriedades e opções válidas de select/status.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
icon | object | Não | Objeto de ícone da página. Ao menos um de properties, archived, icon ou cover é obrigatório. |
cover | object | Não | Imagem de capa da página. Deve conter a chave external (com url) ou file_upload. Ao menos um de properties, archived, icon ou cover é obrigatório. |
page_id | string | Sim | Identificador da página do Notion a ser atualizada. Use page_id como nome do parâmetro. |
archived | boolean | Não | Defina como true para arquivar (mover para lixeira) a página, false para restaurar. Ao menos um de properties, archived, icon ou cover é obrigatório. |
properties | object | Não | Dicionário mapeando nomes de propriedades para objetos de valor. Os nomes de propriedades são case-sensitive e específicos do workspace. Os valores devem ser encapsulados em objetos do tipo de propriedade — nunca envie valores simples. Exemplo: {'Status': {'select': {'name': 'Done'}}}. |
| 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 linha do banco de dados (página)
Seção intitulada “Atualizar linha do banco de dados (página)”NOTION_UPDATE_ROW_DATABASE
Atualiza uma linha/página específica dentro de um banco de dados do Notion pelo seu UUID de página (row_id). IMPORTANTE: esta ação atualiza LINHAS INDIVIDUAIS (páginas) em um banco de dados, NÃO a estrutura do banco de dados. Para atualizar o ESQUEMA do banco de dados, use NOTION_UPDATE_SCHEMA_DATABASE com database_id.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
icon | string | Não | Emoji para usar como ícone da página. Deve ser um único emoji. |
cover | string | Não | URL de uma imagem externa para usar como capa da página. |
row_id | string | Sim | OBRIGATÓRIO: UUID de página da linha do banco de dados a atualizar. Este é um ID de PÁGINA (não de banco de dados). Formato: UUID de 32 caracteres com hífens. NÃO é uma URL ou título de página. |
delete_row | boolean | Não | Se true, a linha (página) será arquivada, excluindo-a efetivamente da visualização ativa. |
properties | array | Não | Lista de propriedades a atualizar. Cada propriedade requer: name (nome exato), type (tipo da propriedade) e value (formatado conforme o tipo). Use status para propriedades Status, NÃO select. Propriedades não listadas permanecem inalteradas. |
| 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 esquema do banco de dados
Seção intitulada “Atualizar esquema do banco de dados”NOTION_UPDATE_SCHEMA_DATABASE
Atualiza o esquema de um banco de dados do Notion existente, incluindo título, descrição e/ou propriedades (colunas). NOTAS IMPORTANTES: ao menos uma atualização (título, descrição ou propriedades) deve ser fornecida; o banco de dados deve estar compartilhado com sua integração; os nomes de propriedades são case-sensitive; ao alterar uma propriedade para o tipo relation, você DEVE fornecer o database_id do banco de dados alvo; remover propriedades EXCLUIRÁ permanentemente aquela coluna e seus dados.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Não | Novo título para o banco de dados. Deixe como None para manter o título existente inalterado. Ao menos um de title, description ou properties deve ser fornecido. |
properties | array | Não | Lista de atualizações de propriedades (colunas) para o esquema do banco de dados. Cada PropertySchemaUpdate deve especificar: name (nome exato case-sensitive da propriedade existente) e uma das ações: rename, new_type ou remove. |
database_id | string | Sim | OBRIGATÓRIO: UUID identificador do banco de dados do Notion a atualizar. Deve ser um ID de BANCO DE DADOS, não um ID de página. |
description | string | Não | Nova descrição para o banco de dados. Deixe como None para manter a descrição existente inalterada. |
| 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. |
Fazer upsert em linhas do banco de dados
Seção intitulada “Fazer upsert em linhas do banco de dados”NOTION_UPSERT_ROW_DATABASE
Faz upsert de linhas em um banco de dados do Notion consultando linhas existentes e criando ou atualizando-as. Use quando precisar sincronizar dados para o Notion sem criar duplicatas. Cada item é correspondido por um filtro e então criado (se não houver correspondência) ou atualizado (se houver correspondência). Suporta operações em lote com tratamento de erros por item.
Parâmetros de entrada
Seção intitulada “Parâmetros de entrada”| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
items | array | Sim | Array de itens para fazer upsert. Cada item contém critérios de correspondência e payloads de criação/atualização. |
options | object | Não | Opções controlando o comportamento do upsert. |
database_id | string | Não | UUID do banco de dados do Notion (legado). Se fornecido sem data_source_id, tentará resolver para data_source_id. Seguro apenas para bancos de dados de fonte única. |
data_source_id | string | Não | UUID da fonte de dados do Notion (preferido). Obrigatório se database_id não for fornecido. |
| 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. |