Official vendor OpenAPI document · agent-readyCRMDeal Pipelineoauth2, apiKey12 EndpointsREST
For Agents
Create, update, search, merge, and batch-manage HubSpot deal records to move opportunities through sales pipelines via /crm/v3/objects/deals.
Use for: I need to create a new deal with $50,000 amount in the Enterprise pipeline, Move a deal to the Closed Won stage and set the close date, Search for all open deals over $10,000 owned by a specific rep, List all deals updated in the last 24 hours for a daily report
Not supported: Does not handle invoicing, payment collection, or commission calculation - use for managing deal records and pipeline stages inside HubSpot CRM only.
The HubSpot Deals API manages the deal records that drive HubSpot sales pipelines, exposing single and batch CRUD plus search across the standard /crm/v3/objects/deals surface. It supports pipeline stage transitions, deal property updates, deal merging, and association lookups so agents can move opportunities through pipelines programmatically. This is the primary API for any AI agent that needs to read, update, or report on revenue-stage data inside HubSpot.
Install Jentic One Beta
Connect the Deals to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Deals, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-crm-deals" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fhubspot.com%2Fhubspot-crm-deals" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Deals API.
Create new deals with pipeline, stage, and amount properties via POST /crm/v3/objects/deals
Move deals to a new pipeline stage with PATCH /crm/v3/objects/deals/{dealId}
Search deals by amount, stage, owner, or close date through POST /crm/v3/objects/deals/search
Bulk-import or update up to 100 deals per call with the batch endpoints
Merge two duplicate deal records into one via POST /crm/v3/objects/deals/merge
Archive lost deals with DELETE /crm/v3/objects/deals/{dealId} while keeping audit history
Use Cases
Patterns agents use Deals API for, with concrete tasks.
★ Pipeline Stage Automation
Move deals between pipeline stages automatically when external events occur - for example, when a contract is signed in the e-signature tool, advance the deal to Closed Won and stamp the close date. The PATCH endpoint updates only the specified properties, so other fields like amount and owner remain untouched. Stage transitions trigger HubSpot's downstream workflows.
Patch deal 12345 with dealstage set to closedwon and closedate set to today's ISO timestamp via PATCH /crm/v3/objects/deals/12345.
Sales Forecasting Pull
Pull all open deals matching forecast criteria - typically pipeline equals 'default', dealstage not in closed states, and closedate within the current quarter - to feed a forecasting dashboard. The search endpoint accepts complex filterGroups, sorts by closedate or amount, and returns paginated results so a forecasting job can stream tens of thousands of deals.
Search HubSpot deals where pipeline equals default, dealstage NOT IN [closedwon, closedlost], and closedate is within the current quarter, returning deal id, amount, and owner.
Deduplicate Inbound Deals
Merge duplicate deal records that arrive from multiple inbound sources (web forms, partner referrals, BDR outreach) into a single record so the rep sees one opportunity. The merge endpoint preserves the primary deal's ID and history while consolidating activities and associations from the secondary deal. Use it after a search confirms two deals refer to the same opportunity.
Call POST /crm/v3/objects/deals/merge with primaryObjectId 1001 and objectIdToMerge 1002, then verify the merged deal returns a 200 with the primary ID.
Agent-Driven Deal Creation via Jentic
An AI sales assistant turns a meeting recap into a new HubSpot deal - with amount, stage, contact association, and owner - without the user touching the CRM. Through Jentic the agent searches for the create-deal operation, loads its input schema, and executes it with structured fields parsed from the call notes. Total integration takes under an hour vs. 2-3 days direct.
Use Jentic to search 'create a HubSpot deal', load the POST /crm/v3/objects/deals schema, and execute it with dealname, amount, dealstage, pipeline, and hubspot_owner_id from the parsed meeting recap.
Key Endpoints
12 endpoints — the hubspot deals api manages the deal records that drive hubspot sales pipelines, exposing single and batch crud plus search across the standard /crm/v3/objects/deals surface.
METHOD
PATH
DESCRIPTION
GET
/crm/v3/objects/deals
List deals with pagination and property selection
POST
/crm/v3/objects/deals
Create a new deal
GET
/crm/v3/objects/deals/{dealId}
Retrieve a deal by ID
PATCH
/crm/v3/objects/deals/{dealId}
Update specific properties on a deal
POST
/crm/v3/objects/deals/batch/upsert
Batch-upsert deals by external ID
POST
/crm/v3/objects/deals/search
Search deals by property filters
POST
/crm/v3/objects/deals/merge
Merge two duplicate deals
GET
/crm/v3/objects/deals
List deals with pagination and property selection
POST
/crm/v3/objects/deals
Create a new deal
GET
/crm/v3/objects/deals/{dealId}
Retrieve a deal by ID
PATCH
/crm/v3/objects/deals/{dealId}
Update specific properties on a deal
POST
/crm/v3/objects/deals/batch/upsert
Batch-upsert deals by external ID
POST
/crm/v3/objects/deals/search
Search deals by property filters
POST
/crm/v3/objects/deals/merge
Merge two duplicate deals
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
D
Deals
- Foundational (D-)41/100
74
Foundational Compliance63
Developer Experience & Jentic Compatibility17
AI-Readiness & Agent Experience94
Agent Usability70
Security59
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
94%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: BSignals: 4
8%
Example Density
How richly the API is illustrated with examples.
95%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
17
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
17%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
52%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
70
Security
Trust, risk posture, and security compliance.
Grade: A-Signals: 1
70%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
59
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: C+Signals: 1
59%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the HubSpot Deals API by hand means handling its OAuth 2.0 authorization-code flow or a private app token, targeting api.hubapi.com, and building batch, search, and merge payloads yourself. Through Jentic you install once, import HubSpot Deals from the API Directory, store the token once, and your agent calls it.
Permission scoping
HubSpot gates this API with per-object OAuth scopes, so you grant only the deal scopes your agent needs and you choose which operations it may call: you can allow creating, reading, and updating deal records while leaving destructive operations like merge out of the allowed set unless you add them.
Credential isolation
Your HubSpot OAuth token or private app token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a HubSpot deal' or 'search deals by stage', and Jentic returns the matching deals operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Deals API through Jentic.
What authentication does the HubSpot Deals API use?
The Deals API accepts OAuth 2.0 with the crm.objects.deals.read or .write scopes, plus legacy OAuth and HubSpot private app API keys via the private-app and private-app-legacy headers. Through Jentic the token is held in your Jentic One instance and injected at execution so it never reaches the agent's context.
Can I move a deal between pipelines with this API?
Yes. Send a PATCH /crm/v3/objects/deals/{dealId} call with both the pipeline and dealstage properties set to a stage that exists in the target pipeline. Updating only dealstage without changing pipeline keeps the deal in its current pipeline.
What are the rate limits for the HubSpot Deals API?
Account-level limits apply - typically 100 requests per 10 seconds for OAuth apps and 190 per 10 seconds for private apps on paid tiers, plus a daily cap. Use POST /crm/v3/objects/deals/batch/upsert for high-volume writes since each batch counts as a single request.
How do I search HubSpot deals through Jentic?
Run jentic.search('search HubSpot deals'), load the schema for POST /crm/v3/objects/deals/search, and execute it with a filterGroups payload (for example, dealstage equals presentationscheduled and amount greater than 10000). Jentic returns results as structured JSON.
Can I merge two duplicate deals via the API?
Yes. POST /crm/v3/objects/deals/merge takes a primaryObjectId (the deal you want to keep) and objectIdToMerge (the duplicate). The merged record retains the primary ID along with consolidated activities and associations from the secondary deal.
Do I need separate calls to associate a deal with a contact?
Yes. The Deals API itself does not create associations. After creating the deal, call the CRM Associations API to link it to the contact, company, or line item - Jentic exposes that as a separate operation you can chain in the same workflow.
Can I limit what my agent is allowed to do with the HubSpot Deals API?
Yes. Because you run Jentic One yourself, your own rules decide which HubSpot Deals operations and which OAuth scopes the agent may use. You can allow it to create, read, update, and search deals through POST and PATCH /crm/v3/objects/deals while leaving destructive operations like the merge and archive endpoints out of the allowed set. The HubSpot token is held by your self-hosted instance and injected only for the operations you permit, so the agent can never call an endpoint you have not granted.
GET STARTED