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 Search API

Operations for searching CRM objects

HubSpot Search 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 Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 28 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.

3 operations 3 paths 28 schemas 3 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 Search API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Search 3

Operations for searching CRM objects

POST
/crm/v3/objects/{objectType}/search
Hubspot Search Crm Objects
searchCRMObjects 1 param body → 200400401
POST
/crm/v3/objects/calls/search
Hubspot Search Calls
searchCalls body → 200default
POST
/crm/v3/objects/notes/search
Hubspot Search Notes
searchNotes body → 200default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Note (7 properties), Error_2 (7 properties), Call (7 properties), Error_3 (7 properties). Each schema is shown below with its type and property counts.

PropertyHistory
object
Historical value of a property
6 properties
FilterGroup
object
A group of filter conditions combined with AND logic. Use multiple filter groups to create OR conditions between groups.
1 property
Filter
object
A single filter condition for a CRM object property.
5 properties 2 required
Error_3
object
Error response
7 properties 3 required
CallSearchRequest
object
Request body for searching calls
6 properties
CRMObject
object
A CRM object record returned from a search.
5 properties
Filter_3
object
A single search filter
5 properties 2 required
SortOption
object
Sort option for search results
2 properties 1 required
ErrorDetail
object
Detailed error information
5 properties 1 required
NextPage_2
object
Information about the next page
2 properties 1 required
Filter_2
object
A single search filter
5 properties 2 required
SearchResponse
object
The response from a CRM search operation.
3 properties
Note
object
Represents a note engagement in the CRM
7 properties 5 required
SearchRequest
object
A search request for CRM objects. Filter groups are combined with OR logic; filters within a group are combined with AND logic.
6 properties
Paging
object
Pagination information for the response.
1 property
CallSearchResponse
object
Search results for calls
3 properties 2 required
FilterGroup_3
object
A group of filters (AND logic within group)
1 property
Paging_2
object
Pagination information
1 property
Paging_3
object
Pagination information
1 property
Error_2
object
Error response
7 properties 3 required
NoteSearchResponse
object
Search results for notes
3 properties 2 required
NextPage
object
Information about the next page
2 properties 1 required
Sort
object
A sort criterion for ordering search results.
2 properties 1 required
Error
object
An error response.
5 properties
FilterGroup_2
object
A group of filters (AND logic within group)
1 property
Call
object
Represents a call engagement in the CRM
7 properties 5 required
PropertyHistory_2
object
Historical value of a property
6 properties
NoteSearchRequest
object
Request body for searching notes
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-search-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