> ## Documentation Index > Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt > Use this file to discover all available pages before exploring further. # Search your site > Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path. Includes options for weighing results by recency and popularity, along with language support. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/cms-site-search-v3.json GET /cms/site-search/v3/search openapi: 3.0.1 info: title: Site Search description: Basepom for all HubSpot Projects version: v3 x-hubspot-product-tier-requirements: marketing: PROFESSIONAL sales: FREE service: FREE cms: PROFESSIONAL commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Build a site search bar to enable users to search through your website content. x-hubspot-related-documentation: - name: Site Search Guide url: https://developers.hubspot.com/docs/guides/api/cms/site-search x-hubspot-introduction: >- Use the site search API to return HubSpot-hosted content based on search terms. Content can be searched across multiple domains. You can also retrieve all indexed data for a specific website page, blog post, or knowledge base article using its ID. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Search paths: /cms/site-search/v3/search: get: tags: - Search summary: Search your site description: >- Returns any website content matching the given search criteria for a given HubSpot account. Searches can be filtered by content type, domain, or URL path. Includes options for weighing results by recency and popularity, along with language support. operationId: get-/cms/site-search/v3/search_/cms/site-search/v3/search parameters: - name: analytics in: query description: '' required: false style: form explode: true schema: type: boolean - name: autocomplete in: query description: '' required: false style: form explode: true schema: type: boolean - name: boostLimit in: query description: '' required: false style: form explode: true schema: type: number - name: boostRecent in: query description: '' required: false style: form explode: true schema: type: string - name: domain in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: groupId in: query description: '' required: false style: form explode: true schema: type: array items: type: integer format: int64 - name: hubdbQuery in: query description: '' required: false style: form explode: true schema: type: string - name: language in: query description: '' required: false style: form explode: true schema: type: string enum: - aa - ab - ae - af - af-na - af-za - agq - agq-cm - ak - ak-gh - am - am-et - an - ann - ann-ng - ar - ar-001 - ar-ae - ar-bh - ar-dj - ar-dz - ar-eg - ar-eh - ar-er - ar-il - ar-iq - ar-jo - ar-km - ar-kw - ar-lb - ar-ly - ar-ma - ar-mr - ar-om - ar-ps - ar-qa - ar-sa - ar-sd - ar-so - ar-ss - ar-sy - ar-td - ar-tn - ar-ye - as - as-in - asa - asa-tz - ast - ast-es - av - ay - az - az-az - ba - bal - bal-pk - bas - bas-cm - be - be-by - bem - bem-zm - bez - bez-tz - bg - bg-bg - bgc - bgc-in - bho - bho-in - bi - blo - blo-bj - bm - bm-ml - bn - bn-bd - bn-in - bo - bo-cn - bo-in - br - br-fr - brx - brx-in - bs - bs-ba - ca - ca-ad - ca-es - ca-fr - ca-it - ccp - ccp-bd - ccp-in - ce - ce-ru - ceb - ceb-ph - cgg - cgg-ug - ch - chr - chr-us - ckb - ckb-iq - ckb-ir - co - cr - cs - cs-cz - csw - csw-ca - cu - cu-ru - cv - cv-ru - cy - cy-gb - da - da-dk - da-gl - dav - dav-ke - de - de-at - de-be - de-ch - de-de - de-gr - de-it - de-li - de-lu - dje - dje-ne - doi - doi-in - dsb - dsb-de - dua - dua-cm - dv - dyo - dyo-sn - dz - dz-bt - ebu - ebu-ke - ee - ee-gh - ee-tg - el - el-cy - el-gr - en - en-001 - en-150 - en-ae - en-ag - en-ai - en-as - en-at - en-au - en-bb - en-be - en-bi - en-bm - en-bs - en-bw - en-bz - en-ca - en-cc - en-ch - en-ck - en-cm - en-cn - en-cx - en-cy - en-cz - en-de - en-dg - en-dk - en-dm - en-ee - en-eg - en-er - en-es - en-fi - en-fj - en-fk - en-fm - en-fr - en-gb - en-gd - en-gg - en-gh - en-gi - en-gm - en-gs - en-gu - en-gy - en-hk - en-hu - en-id - en-ie - en-il - en-im - en-in - en-io - en-it - en-je - en-jm - en-ke - en-ki - en-kn - en-ky - en-lc - en-lr - en-ls - en-lu - en-mg - en-mh - en-mo - en-mp - en-ms - en-mt - en-mu - en-mv - en-mw - en-mx - en-my - en-na - en-nf - en-ng - en-nl - en-no - en-nr - en-nu - en-nz - en-pg - en-ph - en-pk - en-pl - en-pn - en-pr - en-pt - en-pw - en-ro - en-rw - en-sb - en-sc - en-sd - en-se - en-sg - en-sh - en-si - en-sk - en-sl - en-ss - en-sx - en-sz - en-tc - en-th - en-tk - en-tn - en-to - en-tt - en-tv - en-tz - en-ug - en-um - en-us - en-vc - en-vg - en-vi - en-vn - en-vu - en-ws - en-za - en-zm - en-zw - eo - eo-001 - es - es-419 - es-ar - es-bo - es-br - es-bz - es-cl - es-co - es-cr - es-cu - es-do - es-ea - es-ec - es-es - es-gq - es-gt - es-hn - es-ic - es-mx - es-ni - es-pa - es-pe - es-ph - es-pr - es-py - es-sv - es-us - es-uy - es-ve - et - et-ee - eu - eu-es - ewo - ewo-cm - fa - fa-af - fa-ir - ff - ff-bf - ff-cm - ff-gh - ff-gm - ff-gn - ff-gw - ff-lr - ff-mr - ff-ne - ff-ng - ff-sl - ff-sn - fi - fi-fi - fil - fil-ph - fj - fo - fo-dk - fo-fo - fr - fr-be - fr-bf - fr-bi - fr-bj - fr-bl - fr-ca - fr-cd - fr-cf - fr-cg - fr-ch - fr-ci - fr-cm - fr-dj - fr-dz - fr-fr - fr-ga - fr-gf - fr-gn - fr-gp - fr-gq - fr-ht - fr-km - fr-lu - fr-ma - fr-mc - fr-mf - fr-mg - fr-ml - fr-mq - fr-mr - fr-mu - fr-nc - fr-ne - fr-pf - fr-pm - fr-re - fr-rw - fr-sc - fr-sn - fr-sy - fr-td - fr-tg - fr-tn - fr-vu - fr-wf - fr-yt - frr - frr-de - fur - fur-it - fy - fy-nl - ga - ga-gb - ga-ie - gaa - gaa-gh - gd - gd-gb - gl - gl-es - gn - gsw - gsw-ch - gsw-fr - gsw-li - gu - gu-in - guz - guz-ke - gv - gv-im - ha - ha-gh - ha-ne - ha-ng - haw - haw-us - he - he-il - hi - hi-in - hmn - ho - hr - hr-ba - hr-hr - hsb - hsb-de - ht - ht-ht - hu - hu-hu - hy - hy-am - hz - ia - ia-001 - id - id-id - ie - ie-ee - ig - ig-ng - ii - ii-cn - ik - io - is - is-is - it - it-ch - it-it - it-sm - it-va - iu - ja - ja-jp - jgo - jgo-cm - jmc - jmc-tz - jv - jv-id - ka - ka-ge - kab - kab-dz - kam - kam-ke - kar - kde - kde-tz - kea - kea-cv - kg - kgp - kgp-br - kh - khq - khq-ml - ki - ki-ke - kj - kk - kk-kz - kkj - kkj-cm - kl - kl-gl - kln - kln-ke - km - km-kh - kn - kn-in - ko - ko-cn - ko-kp - ko-kr - kok - kok-in - kr - ks - ks-in - ksb - ksb-tz - ksf - ksf-cm - ksh - ksh-de - ku - ku-tr - kv - kw - kw-gb - kxv - kxv-in - ky - ky-kg - la - lag - lag-tz - lb - lb-lu - lg - lg-ug - li - lij - lij-it - lkt - lkt-us - lmo - lmo-it - ln - ln-ao - ln-cd - ln-cf - ln-cg - lo - lo-la - lrc - lrc-iq - lrc-ir - lt - lt-lt - lu - lu-cd - luo - luo-ke - luy - luy-ke - lv - lv-lv - mai - mai-in - mas - mas-ke - mas-tz - mdf - mdf-ru - mer - mer-ke - mfe - mfe-mu - mg - mg-mg - mgh - mgh-mz - mgo - mgo-cm - mh - mi - mi-nz - mk - mk-mk - ml - ml-in - mn - mn-mn - mni - mni-in - mr - mr-in - ms - ms-bn - ms-id - ms-my - ms-sg - mt - mt-mt - mua - mua-cm - my - my-mm - mzn - mzn-ir - na - naq - naq-na - nb - nb-no - nb-sj - nd - nd-zw - nds - nds-de - nds-nl - ne - ne-in - ne-np - ng - nl - nl-aw - nl-be - nl-bq - nl-ch - nl-cw - nl-lu - nl-nl - nl-sr - nl-sx - nmg - nmg-cm - nn - nn-no - nnh - nnh-cm - 'no' - no-no - nqo - nqo-gn - nr - nso - nso-za - nus - nus-ss - nv - ny - nyn - nyn-ug - oc - oc-es - oc-fr - oj - om - om-et - om-ke - or - or-in - os - os-ge - os-ru - pa - pa-in - pa-pk - pcm - pcm-ng - pi - pis - pis-sb - pl - pl-pl - prg - prg-001 - ps - ps-af - ps-pk - pt - pt-ao - pt-br - pt-ch - pt-cv - pt-gq - pt-gw - pt-lu - pt-mo - pt-mz - pt-pt - pt-st - pt-tl - qu - qu-bo - qu-ec - qu-pe - raj - raj-in - rm - rm-ch - rn - rn-bi - ro - ro-md - ro-ro - rof - rof-tz - ru - ru-by - ru-kg - ru-kz - ru-md - ru-ru - ru-ua - rw - rw-rw - rwk - rwk-tz - sa - sa-in - sah - sah-ru - saq - saq-ke - sat - sat-in - sbp - sbp-tz - sc - sc-it - sd - sd-in - sd-pk - se - se-fi - se-no - se-se - seh - seh-mz - ses - ses-ml - sg - sg-cf - shi - shi-ma - si - si-lk - sk - sk-sk - sl - sl-si - sm - smn - smn-fi - sms - sms-fi - sn - sn-zw - so - so-dj - so-et - so-ke - so-so - sq - sq-al - sq-mk - sq-xk - sr - sr-ba - sr-cs - sr-me - sr-rs - sr-xk - ss - st - st-ls - st-za - su - su-id - sv - sv-ax - sv-fi - sv-se - sw - sw-cd - sw-ke - sw-tz - sw-ug - sy - syr - syr-iq - syr-sy - szl - szl-pl - ta - ta-in - ta-lk - ta-my - ta-sg - te - te-in - teo - teo-ke - teo-ug - tg - tg-tj - th - th-th - ti - ti-er - ti-et - tk - tk-tm - tl - tn - tn-bw - tn-za - to - to-to - tok - tok-001 - tr - tr-cy - tr-tr - ts - tt - tt-ru - tw - twq - twq-ne - ty - tzm - tzm-ma - ug - ug-cn - uk - uk-ua - ur - ur-in - ur-pk - uz - uz-af - uz-uz - vai - vai-lr - ve - vec - vec-it - vi - vi-vn - vmw - vmw-mz - vo - vo-001 - vun - vun-tz - wa - wae - wae-ch - wo - wo-sn - xh - xh-za - xnr - xnr-in - xog - xog-ug - yav - yav-cm - yi - yi-001 - yi-ua - yo - yo-bj - yo-ng - yrl - yrl-br - yrl-co - yrl-ve - yue - yue-cn - yue-hk - yue-mo - za - za-cn - zgh - zgh-ma - zh - zh-cn - zh-hans - zh-hant - zh-hk - zh-mo - zh-my - zh-sg - zh-tw - zu - zu-za - name: length in: query description: '' required: false style: form explode: true schema: type: string enum: - LONG - SHORT - name: limit in: query description: The maximum number of results to display per page. required: false style: form explode: true schema: type: integer format: int32 - name: matchPrefix in: query description: '' required: false style: form explode: true schema: type: boolean - name: offset in: query description: '' required: false style: form explode: true schema: type: integer format: int32 - name: pathPrefix in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: popularityBoost in: query description: '' required: false style: form explode: true schema: type: number - name: property in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: q in: query description: '' required: false style: form explode: true schema: type: string - name: tableId in: query description: '' required: false style: form explode: true schema: type: integer format: int64 - name: type in: query description: '' required: false style: form explode: true schema: type: array items: type: string - name: types in: query description: '' required: false style: form explode: true schema: type: array items: type: string enum: - LANDING_PAGE - BLOG_POST - SITE_PAGE - KNOWLEDGE_ARTICLE - LISTING_PAGE - STRUCTURED_CONTENT responses: '200': description: successful operation content: application/json: schema: $ref: '#/components/schemas/PublicSearchResults' default: $ref: '#/components/responses/Error' description: '' security: - oauth2: - content components: schemas: PublicSearchResults: required: - limit - offset - page - results - total type: object properties: limit: type: integer description: The number of results returned in a single response. format: int32 offset: type: integer description: The starting point for the next set of results in pagination. format: int32 page: type: integer description: The current page number in the paginated results. format: int32 results: type: array items: $ref: '#/components/schemas/ContentSearchResult' searchTerm: type: string description: The term used in the search query. total: type: integer description: The total number of results found for the search term. format: int64 ContentSearchResult: required: - domain - id - score - type - url type: object properties: authorFullName: type: string description: Name of the author. category: type: string description: The error category combinedId: type: string description: The ID of the document in HubSpot. contentType: type: string description: type: string description: >- The result's description. The content will be determined by the value of `length` in the request. domain: type: string description: The domain the document is hosted on. featuredImageUrl: type: string description: URL of the featured image. id: type: integer description: The ID of the content. format: int64 inBeta: type: boolean isPrivate: type: boolean language: type: string description: The document's language. enum: - aa - ab - ae - af - af-na - af-za - agq - agq-cm - ak - ak-gh - am - am-et - an - ann - ann-ng - ar - ar-001 - ar-ae - ar-bh - ar-dj - ar-dz - ar-eg - ar-eh - ar-er - ar-il - ar-iq - ar-jo - ar-km - ar-kw - ar-lb - ar-ly - ar-ma - ar-mr - ar-om - ar-ps - ar-qa - ar-sa - ar-sd - ar-so - ar-ss - ar-sy - ar-td - ar-tn - ar-ye - as - as-in - asa - asa-tz - ast - ast-es - av - ay - az - az-az - ba - bal - bal-pk - bas - bas-cm - be - be-by - bem - bem-zm - bez - bez-tz - bg - bg-bg - bgc - bgc-in - bho - bho-in - bi - blo - blo-bj - bm - bm-ml - bn - bn-bd - bn-in - bo - bo-cn - bo-in - br - br-fr - brx - brx-in - bs - bs-ba - ca - ca-ad - ca-es - ca-fr - ca-it - ccp - ccp-bd - ccp-in - ce - ce-ru - ceb - ceb-ph - cgg - cgg-ug - ch - chr - chr-us - ckb - ckb-iq - ckb-ir - co - cr - cs - cs-cz - csw - csw-ca - cu - cu-ru - cv - cv-ru - cy - cy-gb - da - da-dk - da-gl - dav - dav-ke - de - de-at - de-be - de-ch - de-de - de-gr - de-it - de-li - de-lu - dje - dje-ne - doi - doi-in - dsb - dsb-de - dua - dua-cm - dv - dyo - dyo-sn - dz - dz-bt - ebu - ebu-ke - ee - ee-gh - ee-tg - el - el-cy - el-gr - en - en-001 - en-150 - en-ae - en-ag - en-ai - en-as - en-at - en-au - en-bb - en-be - en-bi - en-bm - en-bs - en-bw - en-bz - en-ca - en-cc - en-ch - en-ck - en-cm - en-cn - en-cx - en-cy - en-cz - en-de - en-dg - en-dk - en-dm - en-ee - en-eg - en-er - en-es - en-fi - en-fj - en-fk - en-fm - en-fr - en-gb - en-gd - en-gg - en-gh - en-gi - en-gm - en-gs - en-gu - en-gy - en-hk - en-hu - en-id - en-ie - en-il - en-im - en-in - en-io - en-it - en-je - en-jm - en-ke - en-ki - en-kn - en-ky - en-lc - en-lr - en-ls - en-lu - en-mg - en-mh - en-mo - en-mp - en-ms - en-mt - en-mu - en-mv - en-mw - en-mx - en-my - en-na - en-nf - en-ng - en-nl - en-no - en-nr - en-nu - en-nz - en-pg - en-ph - en-pk - en-pl - en-pn - en-pr - en-pt - en-pw - en-ro - en-rw - en-sb - en-sc - en-sd - en-se - en-sg - en-sh - en-si - en-sk - en-sl - en-ss - en-sx - en-sz - en-tc - en-th - en-tk - en-tn - en-to - en-tt - en-tv - en-tz - en-ug - en-um - en-us - en-vc - en-vg - en-vi - en-vn - en-vu - en-ws - en-za - en-zm - en-zw - eo - eo-001 - es - es-419 - es-ar - es-bo - es-br - es-bz - es-cl - es-co - es-cr - es-cu - es-do - es-ea - es-ec - es-es - es-gq - es-gt - es-hn - es-ic - es-mx - es-ni - es-pa - es-pe - es-ph - es-pr - es-py - es-sv - es-us - es-uy - es-ve - et - et-ee - eu - eu-es - ewo - ewo-cm - fa - fa-af - fa-ir - ff - ff-bf - ff-cm - ff-gh - ff-gm - ff-gn - ff-gw - ff-lr - ff-mr - ff-ne - ff-ng - ff-sl - ff-sn - fi - fi-fi - fil - fil-ph - fj - fo - fo-dk - fo-fo - fr - fr-be - fr-bf - fr-bi - fr-bj - fr-bl - fr-ca - fr-cd - fr-cf - fr-cg - fr-ch - fr-ci - fr-cm - fr-dj - fr-dz - fr-fr - fr-ga - fr-gf - fr-gn - fr-gp - fr-gq - fr-ht - fr-km - fr-lu - fr-ma - fr-mc - fr-mf - fr-mg - fr-ml - fr-mq - fr-mr - fr-mu - fr-nc - fr-ne - fr-pf - fr-pm - fr-re - fr-rw - fr-sc - fr-sn - fr-sy - fr-td - fr-tg - fr-tn - fr-vu - fr-wf - fr-yt - frr - frr-de - fur - fur-it - fy - fy-nl - ga - ga-gb - ga-ie - gaa - gaa-gh - gd - gd-gb - gl - gl-es - gn - gsw - gsw-ch - gsw-fr - gsw-li - gu - gu-in - guz - guz-ke - gv - gv-im - ha - ha-gh - ha-ne - ha-ng - haw - haw-us - he - he-il - hi - hi-in - hmn - ho - hr - hr-ba - hr-hr - hsb - hsb-de - ht - ht-ht - hu - hu-hu - hy - hy-am - hz - ia - ia-001 - id - id-id - ie - ie-ee - ig - ig-ng - ii - ii-cn - ik - io - is - is-is - it - it-ch - it-it - it-sm - it-va - iu - ja - ja-jp - jgo - jgo-cm - jmc - jmc-tz - jv - jv-id - ka - ka-ge - kab - kab-dz - kam - kam-ke - kar - kde - kde-tz - kea - kea-cv - kg - kgp - kgp-br - kh - khq - khq-ml - ki - ki-ke - kj - kk - kk-kz - kkj - kkj-cm - kl - kl-gl - kln - kln-ke - km - km-kh - kn - kn-in - ko - ko-cn - ko-kp - ko-kr - kok - kok-in - kr - ks - ks-in - ksb - ksb-tz - ksf - ksf-cm - ksh - ksh-de - ku - ku-tr - kv - kw - kw-gb - kxv - kxv-in - ky - ky-kg - la - lag - lag-tz - lb - lb-lu - lg - lg-ug - li - lij - lij-it - lkt - lkt-us - lmo - lmo-it - ln - ln-ao - ln-cd - ln-cf - ln-cg - lo - lo-la - lrc - lrc-iq - lrc-ir - lt - lt-lt - lu - lu-cd - luo - luo-ke - luy - luy-ke - lv - lv-lv - mai - mai-in - mas - mas-ke - mas-tz - mdf - mdf-ru - mer - mer-ke - mfe - mfe-mu - mg - mg-mg - mgh - mgh-mz - mgo - mgo-cm - mh - mi - mi-nz - mk - mk-mk - ml - ml-in - mn - mn-mn - mni - mni-in - mr - mr-in - ms - ms-bn - ms-id - ms-my - ms-sg - mt - mt-mt - mua - mua-cm - my - my-mm - mzn - mzn-ir - na - naq - naq-na - nb - nb-no - nb-sj - nd - nd-zw - nds - nds-de - nds-nl - ne - ne-in - ne-np - ng - nl - nl-aw - nl-be - nl-bq - nl-ch - nl-cw - nl-lu - nl-nl - nl-sr - nl-sx - nmg - nmg-cm - nn - nn-no - nnh - nnh-cm - 'no' - no-no - nqo - nqo-gn - nr - nso - nso-za - nus - nus-ss - nv - ny - nyn - nyn-ug - oc - oc-es - oc-fr - oj - om - om-et - om-ke - or - or-in - os - os-ge - os-ru - pa - pa-in - pa-pk - pcm - pcm-ng - pi - pis - pis-sb - pl - pl-pl - prg - prg-001 - ps - ps-af - ps-pk - pt - pt-ao - pt-br - pt-ch - pt-cv - pt-gq - pt-gw - pt-lu - pt-mo - pt-mz - pt-pt - pt-st - pt-tl - qu - qu-bo - qu-ec - qu-pe - raj - raj-in - rm - rm-ch - rn - rn-bi - ro - ro-md - ro-ro - rof - rof-tz - ru - ru-by - ru-kg - ru-kz - ru-md - ru-ru - ru-ua - rw - rw-rw - rwk - rwk-tz - sa - sa-in - sah - sah-ru - saq - saq-ke - sat - sat-in - sbp - sbp-tz - sc - sc-it - sd - sd-in - sd-pk - se - se-fi - se-no - se-se - seh - seh-mz - ses - ses-ml - sg - sg-cf - shi - shi-ma - si - si-lk - sk - sk-sk - sl - sl-si - sm - smn - smn-fi - sms - sms-fi - sn - sn-zw - so - so-dj - so-et - so-ke - so-so - sq - sq-al - sq-mk - sq-xk - sr - sr-ba - sr-cs - sr-me - sr-rs - sr-xk - ss - st - st-ls - st-za - su - su-id - sv - sv-ax - sv-fi - sv-se - sw - sw-cd - sw-ke - sw-tz - sw-ug - sy - syr - syr-iq - syr-sy - szl - szl-pl - ta - ta-in - ta-lk - ta-my - ta-sg - te - te-in - teo - teo-ke - teo-ug - tg - tg-tj - th - th-th - ti - ti-er - ti-et - tk - tk-tm - tl - tn - tn-bw - tn-za - to - to-to - tok - tok-001 - tr - tr-cy - tr-tr - ts - tt - tt-ru - tw - twq - twq-ne - ty - tzm - tzm-ma - ug - ug-cn - uk - uk-ua - ur - ur-in - ur-pk - uz - uz-af - uz-uz - vai - vai-lr - ve - vec - vec-it - vi - vi-vn - vmw - vmw-mz - vo - vo-001 - vun - vun-tz - wa - wae - wae-ch - wo - wo-sn - xh - xh-za - xnr - xnr-in - xog - xog-ug - yav - yav-cm - yi - yi-001 - yi-ua - yo - yo-bj - yo-ng - yrl - yrl-br - yrl-co - yrl-ve - yue - yue-cn - yue-hk - yue-mo - za - za-cn - zgh - zgh-ma - zh - zh-cn - zh-hans - zh-hant - zh-hk - zh-mo - zh-my - zh-sg - zh-tw - zu - zu-za publishedDate: type: integer description: The date the content was published. format: int64 rowId: type: integer description: If a dynamic page, the row ID in the HubDB table. format: int64 score: type: number description: The matching score of the document. subcategory: type: string description: For knowledge articles, the subcategory of the article. tableId: type: integer description: If a dynamic page, the ID of the HubDB table. format: int64 tags: type: array description: If a blog post, the tags associated with it. items: type: string title: type: string description: The title of the returned document. type: type: string description: >- The type of document. Can be `SITE_PAGE`, `LANDING_PAGE`, `BLOG_POST`, `LISTING_PAGE`, or `KNOWLEDGE_ARTICLE`. enum: - BLOG_POST - KNOWLEDGE_ARTICLE - LANDING_PAGE - LISTING_PAGE - SITE_PAGE - STRUCTURED_CONTENT url: type: string description: The url of the document. Error: required: - category - correlationId - message type: object properties: category: type: string description: The error category context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- A unique identifier for the request. Include this value with any error reports or support tickets format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: further information about the error items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- A map of link names to associated URIs containing documentation about the error or recommended remediation steps message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate example: An error occurred subCategory: type: string description: >- A specific category that contains more specific detail about the error description: >- Represents an error response returned by the API when an operation fails. This component is used in various endpoints to provide detailed information about the error encountered. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base ErrorDetail: required: - message type: object properties: code: type: string description: The status code associated with the error detail context: type: object additionalProperties: type: array items: type: string description: Context about the error condition example: '{missingScopes=[scope1, scope2]}' in: type: string description: The name of the field or parameter in which the error was found. message: type: string description: >- A human readable message describing the error along with remediation steps where appropriate subCategory: type: string description: >- A specific category that contains more specific detail about the error description: >- Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://app.hubspot.com/oauth/authorize tokenUrl: https://api.hubapi.com/oauth/v1/token scopes: content: '' ````