HubSpot
Overview
Overview of V4MOS.AI HubSpot API
The V4MOS.AI HubSpot API provides access to HubSpot CRM data: contacts, deals, companies, pipelines, and products synced from HubSpot accounts connected to your organization. All endpoints use the /v1/hubspot prefix and follow the same authentication, pagination, and response patterns used across the platform.
Available Endpoints
- getContacts
/v1/hubspot/contactsReturns HubSpot CRM contacts with lifecycle stage and analytics attribution. - getDeals
/v1/hubspot/dealsReturns HubSpot CRM deals with amount, stage, pipeline, dates, and associations. - getCompanies
/v1/hubspot/companiesReturns HubSpot CRM companies. - getPipelines
/v1/hubspot/pipelinesReturns HubSpot CRM pipelines with stages and display order. - getProducts
/v1/hubspot/productsReturns HubSpot CRM products with name, price, and SKU.
Authentication
All endpoints require the x-client-id and x-client-secret headers, plus the organizationId query parameter. See Authentication.
Common Parameters
organizationId(required) – Organization that owns the HubSpot integrationintegrationId– Integration ID (optional)integrationName– Integration name (optional)page– Page number (default: 1)limit– Records per page (default: 500, max: 5000)createdStart/createdEnd– Filter by creation timestamp (ISO 8601)lastModifiedStart/lastModifiedEnd– Filter by last update timestamp (ISO 8601)
Resource-Specific Filters
Contacts (/v1/hubspot/contacts)
id,email– Filter by contactlifecycleStage– Lifecycle stage (e.g. lead, opportunity, customer)
Deals (/v1/hubspot/deals)
id– Deal IDdealStage– Deal stage (e.g. closedwon, closedlost)pipeline– Pipeline name
Companies (/v1/hubspot/companies)
id– Company ID
Pipelines (/v1/hubspot/pipelines)
id– Pipeline IDlabel– Pipeline label
Products (/v1/hubspot/products)
id– Product IDname– Product namehsSku– HubSpot SKU
Response Format
All responses follow the standard format:
{
"data": [...],
"meta": {
"page": 1,
"limit": 500,
"hasNextPage": true,
"hasPreviousPage": false
}
}HubSpot Data Model Highlights
Contacts
- Identity:
id,email,associated_company_id - Lifecycle:
lifecycle_stage,create_date,first_deal_created_date,close_date - Analytics:
hs_analytics_source,hs_latest_source_* - Timestamps:
created_at,updated_at,last_modified_date,inserted_at
Deals
- Value:
amount,amount_in_home_currency,deal_currency_code,hs_closed_amount,hs_forecast_amount - Stage:
deal_stage,pipeline,hs_is_closed,hs_is_closed_won,hs_is_closed_lost - Dates:
close_date,create_date,hs_closed_won_date,hs_lastmodifieddate - Associations:
assoc_company_ids,assoc_contact_ids,assoc_line_item_ids - Ownership:
hubspot_owner_id,hs_created_by_user_id,hs_updated_by_user_id
Companies
- Identity:
id - Timestamps:
created_at,updated_at,hs_lastmodifieddate,inserted_at
Pipelines
- Identity:
id,label,display_order - Configuration:
stages(array of stage objects with id, label, etc.) - Timestamps:
created_at,updated_at,inserted_at
Products
- Identity:
id,name,hs_sku - Commerce:
price - Timestamps:
created_at,updated_at,inserted_at