Skip to main content
GET
Retrieve knowledge base

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

knowledgeBaseId
string
required

The unique identifier of the knowledge base to retrieve.

Response

successful operation

accessType
enum<string>
required

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

Available options:
ACCESS_GROUP_MEMBERSHIP,
PUBLIC,
SSO_LOGIN
createdAt
string<date-time>
required

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

domain
string
required

The domain associated with the knowledge base.

id
string
required

The unique identifier for the knowledge base.

language
string
required

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

name
string
required

The name of the knowledge base.

path
string
required

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.

translations
object
required

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

updatedAt
string<date-time>
required

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

url
string
required

The full URL of the knowledge base.

createdByUserId
string

The ID of the user who created the knowledge base.

metaDescription
string

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

updatedByUserId
string

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

Last modified on September 28, 2026