Retrieve a knowledge base
Retrieve a specific knowledge base by its ID. Returns its name, language, domain, URL, access settings, language variants (translations), and related metadata.
Supported products
Supported products
Required scopes
Required scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the knowledge base to retrieve.
Response
successful operation
The access level for the knowledge base: PUBLIC, SSO_LOGIN, or ACCESS_GROUP_MEMBERSHIP.
ACCESS_GROUP_MEMBERSHIP, PUBLIC, SSO_LOGIN The date and time the knowledge base was created, in ISO 8601 format.
The domain associated with the knowledge base.
The unique identifier for the knowledge base.
The knowledge base’s language, as an ISO 639 code (e.g. en).
The name of the knowledge base.
The URL path segment for the knowledge base. Combined with domain, this forms the URL field.
A boolean indicating whether related articles are enabled for the knowledge base.
The knowledge base’s translations, keyed by language code, with each value a KnowledgeBaseTranslationSummary.
The date and time when the knowledge base was last updated, in ISO 8601 format.
The full URL of the knowledge base.
The ID of the user who created the knowledge base.
A brief description of the knowledge base, used for SEO.
The unique identifier of the user who last updated the knowledge base.