GET
/
contentsearch
/
v2
/
search
/
{documentId}
Get indexed properties
curl --request GET \
  --url https://api.hubapi.com/contentsearch/v2/search/{documentId}
[
  {
    "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"
      },
      "title": {
        "name": "title",
        "values": [
          "{hubspot topic rule} アイカツ!"
        ],
        "metadataField": false,
        "value": "{hubspot topic rule} アイカツ!"
      },
      "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"
      },
      "portalId": {
        "name": "portalId",
        "values": [
          62515
        ],
        "metadataField": false,
        "value": 62515
      },
      "id": {
        "name": "id",
        "values": [
          3761238962
        ],
        "metadataField": false,
        "value": 3761238962
      }
    },
    "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
  }
]

Required Scopes

This API requires one of the following scopes:
  • content

Path Parameters

documentId
string
required

The ID of the document to retrieve indexed properties for.

Query Parameters

portalId
string
required

The ID of the portal the contact search should be performed against.

type
enum<string>
required

The type of document. Can be one of SITE_PAGE, BLOG_POST, or KNOWLEDGE_ARTICLE.

Available options:
SITE_PAGE,
BLOG_POST,
KNOWLEDGE_ARTICLE

Response

200 - application/json

successful operation

The response is of type object[].