Sign in
Basic

Retrieve knowledge base

Changed on

Retrieve a specific knowledge base by its ID. Returns its name, language, domain, URL, access settings, language variants (translations), and related metadata.

get/cms/knowledge-base/2027-03-beta/knowledge-bases/{knowledgeBaseId}

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/cms/knowledge-base/2027-03-beta/knowledge-bases/{knowledgeBaseId}
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.settings.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.publish)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.write)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.articles.read)
    • OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cms.knowledge_base.settings.write)

Path parameters

knowledgeBaseIdstring required

The unique identifier of the knowledge base to retrieve.

Response

successful operation

accessType'ACCESS_GROUP_MEMBERSHIP' | 'PUBLIC' | 'SSO_LOGIN' required

The access level for the knowledge base: PUBLIC, SSO_LOGIN, or ACCESS_GROUP_MEMBERSHIP.

createdAtstring date-time required

The date and time the knowledge base was created, in ISO 8601 format.

createdByUserIdstring

The ID of the user who created the knowledge base.

domainstring required

The domain associated with the knowledge base.

idstring required

The unique identifier for the knowledge base.

languagestring required

The knowledge base’s language, as an ISO 639 code (e.g. en).

metaDescriptionstring

A brief description of the knowledge base, used for SEO.

namestring required

The name of the knowledge base.

pathstring required

The URL path segment for the knowledge base. Combined with domain, this forms the URL field.

relatedArticlesEnabledboolean required

A boolean indicating whether related articles are enabled for the knowledge base.

translationsobject required

The knowledge base’s translations, keyed by language code, with each value a KnowledgeBaseTranslationSummary.

updatedAtstring date-time required

The date and time when the knowledge base was last updated, in ISO 8601 format.

updatedByUserIdstring

The unique identifier of the user who last updated the knowledge base.

urlstring required

The full URL of the knowledge base.

Changes

  • 2027-03-beta2eff3dd6fefaRevision changes
    • ○

      the security scope cms.knowledge_base.settings.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2

  • 2027-03-betaf542018e1a93Revision changes
    • ○

      the security scope cms.knowledge_base.settings.read was added to the endpoint's security scheme oauth2

    • ○

      the security scope cms.knowledge_base.settings.write was removed from the endpoint's security scheme oauth2