HubSpot: Get indexed properties

← Site search operations · Get started

Operation hubspot.site_search_get_indexed_data

Provider route: GET /cms/site-search/2026-09/indexed-data/{contentId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["siteSearch"]["getIndexedData"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.siteSearch.getIndexedData(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.site_search.get_indexed_data(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.contentId	string	Required within parent	Pattern: .*
query	object	Optional	Additional keys: not allowed
query.type	string	Optional

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get indexed properties — response body

Referenced models: Get indexed properties — response body

Schemas

Get indexed properties — response body

Field	Type	Presence	Description and constraints
$	object	Root
fields	object	Required within parent	The indexed fields in HubSpot. Additional keys: see wildcard field
fields.*	Model	Additional keys	Expand Get indexed properties — response body — fields value
id	string	Required within parent	The ID of the document in HubSpot.
type	string	Required within parent	The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`. Known values: BLOG_POST, KNOWLEDGE_ARTICLE, LANDING_PAGE, LISTING_PAGE, SITE_PAGE, STRUCTURED_CONTENT

Referenced models: Get indexed properties — response body — fields value

Get indexed properties — response body — fields value

Field	Type	Presence	Description and constraints
$	object	Root
metadataField	boolean	Required within parent	Indicates whether the field is a metadata field.
name	string	Required within parent	The name of the indexed field.
value	object	Required within parent	The primary value of the indexed field.
values	array	Required within parent	An array of objects representing multiple values for the indexed field.
values[]	object	Each item

Policy, approvals and errors

SDK function policy ID: hubspot.site_search_get_indexed_data. Catalog operation: site_search_get_indexed_data. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["content"]

Official provider source