There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get indexed properties

Last updated June 17, 2020

GET /contentsearch/v2/search/:documentId

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

content

For a given portal and document ID (page ID, blog post ID, HubDB row ID, etc.), return all indexed data for the document. This is useful when debugging why a particular document is not returned from a custom search.

Required Parameters How to use Description
Portal ID ?portalId= The ID of the portal the contact search should be performed against.
Type &type= The type of document. Can be one of SITE_PAGE, BLOG_POST, or KNOWLEDGE_ARTICLE.

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL for blog post: https://api.hubapi.com/contentsearch/v2/search/3761238962?portalId=62515&type=BLOG_POST Example Response: [ { "score": 1, "id": "3761238962", "type": "blogpost", "nestedIdentity": null, "version": -1, "source": null, "fields": { "_routing": { "name": "_routing", "values": [ "62515" ], "metadataField": true, "value": "62515" }, "description": { "name": "description", "values": [ " " ], "metadataField": false, "value": " " }, "author_full_name": { "name": "author_full_name", "values": [ "test qa" ], "metadataField": false, "value": "test qa" }, "language": { "name": "language", "values": [ "id" ], "metadataField": false, "value": "id" }, "contentGroupId": { "name": "contentGroupId", "values": [ 351076997 ], "metadataField": false, "value": 351076997 }, "type": { "name": "type", "values": [ 2 ], "metadataField": false, "value": 2 }, "title": { "name": "title", "values": [ "{hubspot topic rule} アイカツ!" ], "metadataField": false, "value": "{hubspot topic rule} アイカツ!" }, "author_handle": { "name": "author_handle", "values": [ "" ], "metadataField": false, "value": "" }, "url": { "name": "url", "values": [ "http://demo-hubapi.hs-sites.com/blog/hubspot-topic-rule-aikatsu-125201" ], "metadataField": false, "value": "http://demo-hubapi.hs-sites.com/blog/hubspot-topic-rule-aikatsu-125201" }, "path": { "name": "path", "values": [ "/blog/hubspot-topic-rule-aikatsu-125201" ], "metadataField": false, "value": "/blog/hubspot-topic-rule-aikatsu-125201" }, "html_h1": { "name": "html_h1", "values": [ "API Demonstration Blog", "{hubspot topic rule} アイカツ!" ], "metadataField": false, "value": "API Demonstration Blog" }, "html_h2": { "name": "html_h2", "values": [ "Something Powerful", "Something Powerful", "Something Powerful", "Something Powerful", "Something Powerful" ], "metadataField": false, "value": "Something Powerful" }, "html_h3": { "name": "html_h3", "values": [ "Tell The Reader More", "Tell The Reader More", "Tell The Reader More", "Tell The Reader More", "Subscribe to Email Updates", "Recent Posts", "Posts by Topic", "Tell The Reader More" ], "metadataField": false, "value": "Tell The Reader More" }, "html_other": { "name": "html_other", "values": [ "Home page", "About Us", "Management Team", "API Demonstration Blog", "Products", "Product 1", "Product 666", "OutGoing Link", "Something Powerful", "Tell The Reader More", "The headline and subheader tells us what you're offering , and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.", "Remember:", "Bullets are great", "For spelling out benefits and", "Turning visitors into leads.", "Something Powerful", "Tell The Reader More", "The headline and subheader tells us what you're offering , and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.", "Remember:", "Bullets are great", "For spelling out benefits and", "Turning visitors into leads.", "API Demonstration Blog", "{hubspot topic rule} アイカツ!", "Posted by test qa on Jan 8, 2016 4:42:30 PM", "Tweet", "Something Powerful", "Tell The Reader More", "The headline and subheader tells us what you're offering , and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.", "Remember:", "Bullets are great", "For spelling out benefits and", "Turning visitors into leads.", "Something Powerful", "Tell The Reader More", "The headline and subheader tells us what you're offering , and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.", "Remember:", "Bullets are great", "For spelling out benefits and", "Turning visitors into leads.", "Subscribe to Email Updates", "Recent Posts", "Posts by Topic", "Merged Topdic (16)", "marketing (4)", "Ipsum (2)", "A New Topic (1)", "Hey A New Topic (1)", "Lorem (1)", "Merged Topic (1)", "Topic Test 575122c8b18eb (1)", "centigos-tag (1)", "time (1)", "udpzEgqDVkF (1)", "whatatopic (1)", "see all", "Something Powerful", "Tell The Reader More", "The headline and subheader tells us what you're offering , and the form header closes the deal. Over here you can explain why your offer is so great it's worth filling out a form for.", "Remember:", "Bullets are great", "For spelling out benefits and", "Turning visitors into leads.", "*header", "*content", "*footer", "© 2018 CompNameHere", "Title of the document", "TestTesttersTest", "11111111111111" ], "metadataField": false, "value": "Home page" }, "publicAccessRulesEnabled": { "name": "publicAccessRulesEnabled", "values": [ false ], "metadataField": false, "value": false }, "portalId": { "name": "portalId", "values": [ 62515 ], "metadataField": false, "value": 62515 }, "domain": { "name": "domain", "values": [ "demo-hubapi.hs-sites.com" ], "metadataField": false, "value": "demo-hubapi.hs-sites.com" }, "id": { "name": "id", "values": [ 3761238962 ], "metadataField": false, "value": 3761238962 }, "author_full_name_raw": { "name": "author_full_name_raw", "values": [ "test qa" ], "metadataField": false, "value": "test qa" }, "publishedDate": { "name": "publishedDate", "values": [ 1452289350000 ], "metadataField": false, "value": 1452289350000 } }, "highlightFields": {}, "sortValues": [], "matchedQueries": [], "explanation": null, "shard": { "nodeId": "jmP04PTuRKmwkNk_JuYDrw", "index": "content-blogposts-3", "shardId": 15 }, "innerHits": null, "sourceRef": null, "index": "content-blogposts-3", "sourceEmpty": true, "sourceAsString": null } ]