KnowledgeBase

A Groove Knowledge Base, containing categories and articles.

To fetch all Knowledge Bases on the account:

query Kbs {
  knowledgeBases {
    nodes {
      createdAt
      customDomain {
        domain
        expiresAt
        letsencrypt
        status
        valid
      }
      customScriptsEnabled
      enabled
      gaAnonymized
      gaCode
      id
      ipAddresses
      ipAddressesEnabled
      language
      meta {
        description
        robots
      }
      openGraph {
        description
        imageUrl
        title
      }
      pageTitle
      password
      passwordEnabled
      primary
      ratingsType
      redirectLegacy
      siteUrl
      subdomain
      subdomainUrl
      title
      updatedAt
      newWidgetId
    }
  }

To fetch related articles:

query KbsWithArticles {
  knowledgeBases {
    nodes {
      id
      articles {
        totalCount
        totalPageCount
        edges {
          node {
            attachments {
              nodes {
                id
              }
            }
            body
            category {
              id
            }
            createdAt
            deletedAt
            id
            ratings {
              nodes {
                id
              }
            }
            ratingsType
            relatedArticles{
              nodes {
                id
              }
            }
            tags
            updatedAt
            
    ... on Publishable {
      author {
        id
        email
      }
      description
      featured
      meta {
        description
        robots
      }
      openGraph {
        description
        imageUrl
        title
      }
      pageTitle
      position
      publishedAt
      slug
      state
      title
      updater {
        id
        email
      }
    }
  
          }
        }
      }
    }
  }
}

To fetch related Knowledge Base categories:

query KbsWithCategories {
  knowledgeBases {
    nodes {
      id
      categories {
        nodes {
          articles {
            nodes {
              id
            }
          }
          createdAt
          coverImageUrl
          id
          updatedAt
          
    ... on Publishable {
      author {
        id
        email
      }
      description
      featured
      meta {
        description
        robots
      }
      openGraph {
        description
        imageUrl
        title
      }
      pageTitle
      position
      publishedAt
      slug
      state
      title
      updater {
        id
        email
      }
    }
  
        }
      }
    }
  }
}

type KnowledgeBase implements Node, Timestamped {
  articles(
  after: String
  before: String
  first: Int
  last: Int
): ArticleConnection!
  canMigrate: Boolean!
  categories(
  after: String
  before: String
  first: Int
  last: Int
): KbCategoryConnection!
  createdAt: DateTime!
  customDomain: CustomDomain!
  customScriptsEnabled: Boolean
  enabled: Boolean!
  gaAnonymized: Boolean
  gaCode: String
  gaVersion: Int
  id: ID!
  instantDocsKbId: String
  instantDocsMigrationToken: String
  instantDocsUrl: String
  ipAddresses: [String!]
  ipAddressesEnabled: Boolean!
  isReadOnly: Boolean!
  language: String
  meta: Meta
  migrationCutoffEnforced: Boolean!
  migrationInitiatedAt: ISO8601DateTime
  migrationStatus: String!
  newWidgetId: ID
  openGraph: OpenGraph
  pageTitle: String
  password: String
  passwordEnabled: Boolean!
  primary: Boolean!
  publishedTheme: Theme!
  ratingsType: KbRating!
  redirectLegacy: Boolean!
  siteUrl: Url!
  subdomain: String!
  subdomainUrl: Url!
  theme: Theme!
  title: String
  updatedAt: DateTime!
}

Fields

KnowledgeBase.articles ● ArticleConnection! non-null object common

The articles in the Knowledge Base.

KnowledgeBase.articles.after ● String scalar common

Returns the elements in the list that come after the specified cursor.

KnowledgeBase.articles.before ● String scalar common

Returns the elements in the list that come before the specified cursor.

KnowledgeBase.articles.first ● Int scalar common

Returns the first n elements from the list.

KnowledgeBase.articles.last ● Int scalar common

Returns the last n elements from the list.

KnowledgeBase.canMigrate ● Boolean! non-null scalar common

True if the Knowledge Base can be migrated; false otherwise.

KnowledgeBase.categories ● KbCategoryConnection! non-null object common

The categories in the Knowledge Base.

KnowledgeBase.categories.after ● String scalar common

Returns the elements in the list that come after the specified cursor.

KnowledgeBase.categories.before ● String scalar common

Returns the elements in the list that come before the specified cursor.

KnowledgeBase.categories.first ● Int scalar common

Returns the first n elements from the list.

KnowledgeBase.categories.last ● Int scalar common

Returns the last n elements from the list.

KnowledgeBase.createdAt ● DateTime! non-null scalar common

The date and time that the object was created.

KnowledgeBase.customDomain ● CustomDomain! non-null object common

The custom domain settings of the Knowledge Base.

KnowledgeBase.customScriptsEnabled ● Boolean scalar common

True if the Knowledge Base can use custom scripts; false otherwise.

KnowledgeBase.enabled ● Boolean! non-null scalar common

True if the Knowledge Base is accessible; false otherwise.

KnowledgeBase.gaAnonymized ● Boolean scalar common

True if the Google Analytics tracking anonymizes IP addresses; false otherwise.

KnowledgeBase.gaCode ● String scalar common

The Google Analytics tracking code for the Knowledge Base.

KnowledgeBase.gaVersion ● Int scalar common

The Google Analytics tracking code version.

KnowledgeBase.id ● ID! non-null scalar common

KnowledgeBase.instantDocsKbId ● String scalar common

The ID of the migrated Instant Docs knowledge base.

KnowledgeBase.instantDocsMigrationToken ● String scalar common

The token for the instant docs migration of the Knowledge Base.

KnowledgeBase.instantDocsUrl ● String scalar common

The URL of the migrated Instant Docs knowledge base.

KnowledgeBase.ipAddresses ● [String!] list scalar common

The list of whitelisted IP addresses for the Knowledge Base.

KnowledgeBase.ipAddressesEnabled ● Boolean! non-null scalar common

True if the Knowledge Base is protected with IP whitelisting; false otherwise.

KnowledgeBase.isReadOnly ● Boolean! non-null scalar common

True if the Knowledge Base is in read-only mode due to migration; false otherwise.

KnowledgeBase.language ● String scalar common

The RFC 5646 language code of the Knowledge Base.

KnowledgeBase.meta ● Meta object common

The meta data of the Knowledge Base.

KnowledgeBase.migrationCutoffEnforced ● Boolean! non-null scalar common

True if the migration cutoff has been enforced; false otherwise.

KnowledgeBase.migrationInitiatedAt ● ISO8601DateTime scalar common

The timestamp when migration was initiated.

KnowledgeBase.migrationStatus ● String! non-null scalar common

The migration status of the Knowledge Base (pending, initiated, completed).

KnowledgeBase.newWidgetId ● ID scalar common

The ID of the widget that should be displayed in the KB

KnowledgeBase.openGraph ● OpenGraph object common

The Open Graph information of the Knowledge Base.

KnowledgeBase.pageTitle ● String scalar common

The HTML page title of the object.

KnowledgeBase.password ● String scalar common

The password of the Knowledge Base.

KnowledgeBase.passwordEnabled ● Boolean! non-null scalar common

True if the Knowledge Base is protected with a password; false otherwise.

KnowledgeBase.primary ● Boolean! non-null scalar common

True if the Knowledge Base is the primary Knowledge Base; false otherwise.

KnowledgeBase.publishedTheme ● Theme! non-null object common

The published theme of the Knowledge Base.

KnowledgeBase.ratingsType ● KbRating! non-null enum common

The type of the Knowledge Base ratings.

KnowledgeBase.redirectLegacy ● Boolean! non-null scalar common

True if the legacy Knowledge Base redirects to this one; false otherwise.

KnowledgeBase.siteUrl ● Url! non-null scalar common

The base URL of the Knowledge Base.

KnowledgeBase.subdomain ● String! non-null scalar common

The subdomain of the Knowledge Base.

KnowledgeBase.subdomainUrl ● Url! non-null scalar common

The subdomain URL of the Knowledge Base.

KnowledgeBase.theme ● Theme! non-null object common

The current theme of the Knowledge Base.

KnowledgeBase.title ● String scalar common

The title of the Knowledge Base.

KnowledgeBase.updatedAt ● DateTime! non-null scalar common

The date and time that the object was last updated.

Interfaces

Node interface common

An object with an ID.

Timestamped interface common

An object with timestamp fields for when it was created and last updated.

Member of

Article object ● DemoEmailChannel object ● EmailChannel object ● EmailInterface interface ● KbCategory object ● KnowledgeBaseConnection object ● KnowledgeBaseEdge object