Visão geral

A API HubSpot da V4MOS.AI fornece acesso aos dados do HubSpot CRM: contatos, deals, empresas, pipelines e produtos sincronizados das contas HubSpot conectadas ao seu organization. Todos os endpoints usam o prefixo /v1/hubspot e seguem os mesmos padrões de autenticação, paginação e resposta da plataforma.

Endpoints disponíveisCopiar link da seção

• getContatos/v1/hubspot/contactsRetorna contatos do CRM do HubSpot com estágio do ciclo de vida e atribuição de analytics.
• getNegócios/v1/hubspot/dealsRetorna deals do CRM do HubSpot com valor, estágio, pipeline, datas e associações.
• getEmpresas/v1/hubspot/companiesRetorna empresas do CRM do HubSpot.
• getPipelines/v1/hubspot/pipelinesRetorna pipelines do CRM do HubSpot com estágios e ordem de exibição.
• getProdutos/v1/hubspot/productsRetorna produtos do CRM do HubSpot com nome, preço e SKU.

AutenticaçãoCopiar link da seção

Todos os endpoints exigem os headers x-client-id e x-client-secret, além do query parameter organizationId. Veja Autenticação.

Parâmetros comunsCopiar link da seção

• organizationId (obrigatório) – Organização que possui a integração HubSpot
• integrationId – ID da integração (opcional)
• integrationName – Nome da integração (opcional)
• page – Número da página (padrão: 1)
• limit – Registros por página (padrão: 500, máx.: 5000)
• createdStart / createdEnd – Filtro por data de criação (ISO 8601)
• lastModifiedStart / lastModifiedEnd – Filtro por data da última alteração (ISO 8601)

Filtros por recursoCopiar link da seção

Contatos (/v1/hubspot/contacts)Copiar link da seção

• id, email – Filtro por contato
• lifecycleStage – Estágio do lifecycle (ex.: lead, opportunity, customer)

Deals (/v1/hubspot/deals)Copiar link da seção

• id – ID do deal
• dealStage – Estágio do deal (ex.: closedwon, closedlost)
• pipeline – Nome do pipeline

Empresas (/v1/hubspot/companies)Copiar link da seção

• id – ID da empresa

Pipelines (/v1/hubspot/pipelines)Copiar link da seção

• id – ID do pipeline
• label – Rótulo do pipeline

Produtos (/v1/hubspot/products)Copiar link da seção

• id – ID do produto
• name – Nome do produto
• hsSku – SKU no HubSpot

Formato da respostaCopiar link da seção

Todas as respostas seguem o formato padrão:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Destaques do modelo de dados HubSpotCopiar link da seção

ContatosCopiar link da seção

• Identidade: id, email, associated_company_id
• Lifecycle: lifecycle_stage, create_date, first_deal_created_date, close_date
• Analytics: hs_analytics_source, hs_latest_source_*
• Datas: created_at, updated_at, last_modified_date, inserted_at

DealsCopiar link da seção

• Valor: amount, amount_in_home_currency, deal_currency_code, hs_closed_amount, hs_forecast_amount
• Estágio: deal_stage, pipeline, hs_is_closed, hs_is_closed_won, hs_is_closed_lost
• Datas: close_date, create_date, hs_closed_won_date, hs_lastmodifieddate
• Associações: assoc_company_ids, assoc_contact_ids, assoc_line_item_ids
• Responsável: hubspot_owner_id, hs_created_by_user_id, hs_updated_by_user_id

EmpresasCopiar link da seção

• Identidade: id
• Datas: created_at, updated_at, hs_lastmodifieddate, inserted_at

PipelinesCopiar link da seção

• Identidade: id, label, display_order
• Configuração: stages (array de estágios com id, label, etc.)
• Datas: created_at, updated_at, inserted_at

ProdutosCopiar link da seção

• Identidade: id, name, hs_sku
• Comércio: price
• Datas: created_at, updated_at, inserted_at