Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HubSpot Deals API

Operations for managing deal records

HubSpot Deals API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 652 JSON Schema definitions.

Tagged areas include Deals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hubapi.com.

6 operations 3 paths 10 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Deals API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Deals 6

Operations for managing deal records

GET
/crm/v3/objects/deals
Hubspot List Deals
listDeals 4 params → 200401
POST
/crm/v3/objects/deals
Hubspot Create a Deal
createDeal body → 201400401
GET
/crm/v3/objects/deals/{dealId}
Hubspot Get a Deal
getDeal 3 params → 200401404
PATCH
/crm/v3/objects/deals/{dealId}
Hubspot Update a Deal
updateDeal 1 param body → 200400401404
DELETE
/crm/v3/objects/deals/{dealId}
Hubspot Archive a Deal
deleteDeal 1 param → 204401404
POST
/crm/v3/objects/deals/search
Hubspot Search Deals
searchDeals body → 200400401

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are SearchRequest (6 properties), Deal (6 properties), Error (4 properties), Filter (3 properties). Each schema is shown below with its type and property counts.

FilterGroup
object
A group of filters combined with AND logic.
1 property
Error
object
An error response.
4 properties
SimplePublicObjectInput
object
Input for creating or updating a CRM object.
1 property
Deal
object
A HubSpot deal record.
6 properties
Association
object
An association between two CRM objects.
2 properties
SearchRequest
object
A search request for CRM objects.
6 properties
Paging
object
Pagination information.
1 property
Filter
object
A single filter condition.
3 properties
CollectionResponseDeal
object
A paginated list of deal records.
2 properties
CollectionResponseAssociation
object
A list of associations.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-deals-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API