A referência de APIs legadas abrange os endpoints mais antigos do HubSpot com versionamento numérico. Essas APIs abrangem quatro níveis principais de versão — v4, v3, v2 e v1 — cada um refletindo diferentes gerações da plataforma HubSpot. Os endpoints seguem o padrão:Documentation Index
Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
APIs por versão
v4
Os endpoints v4 representam as APIs mais recentes do HubSpot antes do versionamento por data, abrangendo associações e ações de automação.- Associações CRM v4: (
/crm/v4/associations/,/crm/v4/objects/{objectType}/{objectId}/associations/) crie, leia e exclua associações entre registros; configure rótulos e tipos de associação - Ações de workflow de automação v4: (
/automation/v4/actions/) defina ações de workflow personalizadas com campos de entrada, callbacks de execução e definições de ação
v3
A maioria das APIs principais da plataforma HubSpot está na v3. Estas incluem os endpoints primários de CRM, CMS, automação e marketing.- Objetos CRM v3: (
/crm/v3/objects/{objectType}) operações CRUD e em lote para contatos, empresas, negócios, tickets e todos os outros objetos CRM padrão e personalizados; inclui pesquisa, mesclagem, exclusão GDPR e gerenciamento de schema - Associações CRM v3: (
/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/) leitura, criação e exclusão em lote de associações - Propriedades CRM v3: (
/crm/v3/properties/{objectType}) crie e gerencie propriedades de objetos e grupos de propriedades - Pipelines CRM v3: (
/crm/v3/pipelines/{objectType}) gerencie pipelines e etapas de negócios e tickets - Importações/Exportações CRM v3: (
/crm/v3/imports/,/crm/v3/exports/) importação e exportação em massa de registros CRM - Listas CRM v3: (
/crm/v3/lists/) crie e gerencie listas de contatos e empresas - Extensões CRM v3: (
/crm/v3/extensions/) extensões de chamadas e integrações de videoconferência - Workflows de automação v3: (
/automation/v3/workflows/) crie, recupere e exclua workflows do HubSpot - Conversas v3: (
/conversations/v3/) gerencie caixas de entrada, threads, mensagens e canais personalizados - CMS v3: (
/cms/v3/) posts de blog, páginas, HubDB, código-fonte, domínios, mapeamentos de URL e redirecionamentos - Eventos de marketing v3: (
/marketing/v3/marketing-events/) crie e gerencie registros de eventos de marketing e participação - Preferências de comunicação v3: (
/communication-preferences/v3/) gerencie definições e status de assinaturas - Webhooks v3: (
/webhooks/v3/) configure assinaturas e configurações de webhooks - Eventos v3: (
/events/v3/) envie e gerencie eventos comportamentais personalizados - Arquivos v3: (
/files/v3/) faça upload, gerencie e recupere arquivos e pastas
v2
As APIs v2 são versões mais antigas dos endpoints de CRM e CMS, muitas das quais têm substituições na v3.- Propriedades CRM v2: (
/properties/v2/{objectType}/properties) gerencie propriedades e grupos de propriedades de contatos, empresas e negócios - Empresas CRM v2: (
/companies/v2/companies/) crie, leia, atualize e exclua registros de empresas - Negócios CRM v2: (sobreposição com v1; alguns endpoints de atualização em lote em caminhos de nível de negócio)
- Posts de blog CMS v2: (
/content/api/v2/blog-posts/) gerencie rascunhos, versões e publicação de posts de blog - Páginas CMS v2: (
/content/api/v2/pages/) gerencie páginas de website e landing pages - Configurações de blog CMS v2: (
/content/api/v2/blogs/) leia a configuração do blog - Busca no site CMS v2: (
/site-search/v2/) pesquise conteúdo indexado do site e recupere propriedades indexadas - Layouts e templates CMS v2: (
/content/api/v2/) gerencie templates e layouts do CMS - Workflows de automação v2: (
/automation/v2/workflows/) gerencie a inscrição de contatos em workflows - Formulários de marketing v2: (
/forms/v2/forms/) crie, leia, atualize e exclua formulários do HubSpot; recupere definições de campos
v1
As APIs v1 são a geração mais antiga e abrangem principalmente contatos, negócios, engajamentos e endpoints de conta legados.- Contatos CRM v1: (
/contacts/v1/) crie, leia, atualize e exclua contatos; gerencie e-mails secundários; operações em lote; pesquisa - Negócios CRM v1: (
/deals/v1/deal/) crie, leia, atualize e exclua registros de negócios; atualizações assíncronas em lote - Itens de linha CRM v1: (
/crm-objects/v1/objects/line-items/) gerencie registros de itens de linha e operações em lote - Produtos CRM v1: (
/crm-objects/v1/objects/products/) gerencie registros de produtos - Tickets CRM v1: (
/crm-objects/v1/objects/tickets/) gerencie registros de tickets - Proprietários CRM v2: (
/owners/v2/owners/) recupere proprietários do CRM - Pipelines CRM v1: (
/crm-pipelines/v1/pipelines/{objectType}) gerencie pipelines e etapas - Listas CRM v1: (
/contacts/v1/lists/) crie e gerencie listas de contatos estáticas e dinâmicas - Associações CRM v1: (
/crm-associations/v1/associations/) crie, leia e exclua associações entre objetos - Engajamentos CRM v1: (
/engagements/v1/engagements/) crie e gerencie chamadas, e-mails, reuniões, notas e tarefas como registros de engajamento - Extensões CRM v1: (
/extensions/sales-objects/v1/) configure tipos de objetos de cartão CRM - Informações da conta v1: (
/integrations/v1/me) recupere informações básicas sobre a conta autenticada - Preferências de comunicação v1: (
/email/public/v1/subscriptions/) leia e atualize status de assinaturas de e-mail - Formulários de marketing v1: (
/form-integrations/v1/) recupere envios de formulários e URLs de arquivos assinados - Envio transacional de marketing v1: (
/email/public/v1/singleEmail/send) envie e-mails transacionais individuais; gerencie tokens da API SMTP - Domínios CMS v1: (
/cms/v1/domains/) liste e recupere configurações de domínios do CMS - Relatórios v2: (
/analytics/v2/reports/) recupere dados analíticos de conteúdo e eventos