HubSpot Site Search

Name: Site Search API
Brand: Site Search
Availability: InStock

✓ Official Vendor SpecMarketingContent Managementoauth2, apiKey2 EndpointsREST

Install Jentic One Beta

Connect the Site Search to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Site Search, 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.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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 Site Search API.

Run a keyword search across a HubSpot CMS website and return ranked results

Filter search results by content type, language, domain, and pathPrefix

Inspect the raw indexed payload for a specific content ID to debug ranking

GET STARTED

Start building with Site Search API

Explore with Jentic

View OpenAPI Document

For Agents

Run search queries against a HubSpot CMS website's index and inspect indexed content for a given page or post, so an agent can answer questions about the customer's public site.

Use for: Search the HubSpot website for 'pricing', Find every blog post on the customer's CMS that mentions 'integrations', Check whether landing page 12345 has been indexed, List all knowledge base articles matching 'reset password'

Not supported: Does not modify content, manage the index, or search HubDB tables - use for querying and inspecting the existing HubSpot CMS search index only.

The HubSpot CMS Site Search API queries the search index that HubSpot maintains for content hosted on its CMS - site pages, landing pages, blog posts, and knowledge base articles. It exposes a search endpoint that returns ranked results plus an inspector endpoint that returns the indexed payload for a specific content ID, useful for debugging why a page does or does not appear in results. Use it to power on-site search experiences or to programmatically query a portal's public content.

Use Cases

Patterns agents use Site Search API for, with concrete tasks.

★ On-Site Search Box

Marketing teams that publish a site on HubSpot want a search box without contracting a third-party search vendor. The Site Search API returns ranked content from the same index HubSpot uses, supporting filters by language, domain, and content type. A single GET on the search endpoint is enough to back a working search UI.

GET /cms/v3/site-search/search?term='pricing'&type=BLOG_POST&language=en, render the top 10 results with title and URL, and link each to the matching live page.

Indexing Debug

When a freshly published page does not appear in search, content teams need a deterministic way to confirm whether it is indexed at all. The /indexed-data endpoint returns the indexed body and metadata for a content ID, surfacing missing fields or empty content that explain low ranking.

GET /cms/v3/site-search/indexed-data/{contentId} for a recently published page, confirm the body field is non-empty, and flag the page for re-indexing if it is.

Agent RAG Over the Customer's Public Site

An AI agent answering questions about a company's product can ground its answers in the customer's own marketing site. Using the search endpoint as a retrieval layer, the agent fetches the most relevant pages and posts for a user query, then summarises them - keeping answers consistent with published positioning.

Use Jentic to search 'hubspot site search', load the schema, execute it with the user's query, and pass the top 5 result URLs into the agent's summarisation prompt.

Content Quality Sweep

Content auditors run periodic queries against the public site to surface stale or duplicated pages. A scheduled agent fires search queries for known brand terms and surfaces pages whose snippets appear duplicated across multiple URLs, feeding into a remediation queue for the content team.

GET /cms/v3/site-search/search for each brand term, group results by snippet hash, and flag any term with more than three near-duplicate snippets.

Key Endpoints

2 endpoints — the hubspot cms site search api queries the search index that hubspot maintains for content hosted on its cms - site pages, landing pages, blog posts, and knowledge base articles.

METHOD

PATH

DESCRIPTION

GET

/cms/v3/site-search/search

Run a search query against the CMS index

GET

/cms/v3/site-search/indexed-data/{contentId}

Retrieve indexed data for a specific content ID

GET

/cms/v3/site-search/search

Run a search query against the CMS index

GET

/cms/v3/site-search/indexed-data/{contentId}

Retrieve indexed data for a specific content ID

Why Jentic?

Three things that make agents converge on Jentic-routed access.

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 'query the HubSpot site search index', and Jentic returns the matching Site Search operation with its filter schema so the agent calls the right endpoint without browsing the reference docs.

Time to first call

FAQs

Specific to using Site Search API through Jentic.

What authentication does the HubSpot Site Search API use?

It accepts HubSpot OAuth 2.0 tokens or Private App tokens in the Authorization header. The /search endpoint is treated as a public-facing operation, while /indexed-data requires a content scope. Through Jentic, the relevant credentials are stored encrypted and the agent only sees a scoped execution token.

Can the Site Search API search content from any HubSpot portal?

It searches the CMS content of the portal whose credentials authorise the call. To search a different portal, supply credentials for that portal - the API does not perform cross-portal search.

What are the rate limits for the HubSpot Site Search API?

It uses HubSpot's standard public API caps: 100 requests per 10 seconds for OAuth apps and 110 per 10 seconds for Private Apps on Pro and Enterprise. Cache hot queries client-side to keep usage low for high-traffic search boxes.

How do I run a site search through Jentic?

After pip install jentic, search 'hubspot site search query', load the schema, and execute it with term and any filters such as type=BLOG_POST or language=en. Jentic returns the parsed result list to the agent.

Does the Site Search API index custom database tables (HubDB)?

No. It indexes published CMS content - site pages, landing pages, blog posts, and knowledge base articles. HubDB rows are queried via the HubDB API, which is a separate surface.

Can I limit what my agent is allowed to do with the HubSpot Site Search API?

Yes. Because you run Jentic One yourself, your own rules decide which of the two Site Search operations the agent may call and which HubSpot credentials it can use. Both operations are read-only, so nothing the agent runs can modify your content or the search index. And since the indexed-data endpoint takes the content ID in its path (/cms/v3/site-search/indexed-data/{contentId}), you can pin the agent to inspecting a single indexed record rather than the whole search endpoint.