Skip to content

HubSpot: Site search schemas

2 HubSpot schemas with complete fields and constraints.

← Site search operations · All schemas

Get indexed properties — response body

FieldTypePresenceDescription and constraints
$objectRoot
fieldsobjectRequired within parentThe indexed fields in HubSpot.
Additional keys: see wildcard field
fields.*ModelAdditional keysExpand Get indexed properties — response body — fields value
idstringRequired within parentThe ID of the document in HubSpot.
typestringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
metadataFieldbooleanRequired within parentIndicates whether the field is a metadata field.
namestringRequired within parentThe name of the indexed field.
valueobjectRequired within parentThe primary value of the indexed field.
valuesarrayRequired within parentAn array of objects representing multiple values for the indexed field.
values[]objectEach item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.