Skip to main content

KbCategory

A category from a Knowledge Base. Each category can contain multiple articles.

To fetch multiple Knowledge Bases with related 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 KbCategory implements Node, Publishable, Timestamped {
  articles(
  after: String
  before: String
  first: Int
  last: Int
): ArticleConnection!
  author: Agent
  coverImageUrl: Url
  createdAt: DateTime!
  currentSlug: String
  description: String
  featured: Boolean!
  id: ID!
  knowledgeBase: KnowledgeBase!
  meta: Meta
  openGraph: OpenGraph
  pageTitle: String
  position: Int!
  previousSlugs: [String!]!
  publishedAt: DateTime
  slug: String
  state: PublishState!
  title: String
  updatedAt: DateTime!
  updater: Agent
}

Fields​

KbCategory.articles ● ArticleConnection! non-null object common​

The articles assigned to the category.

KbCategory.articles.after ● String scalar common​

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

KbCategory.articles.before ● String scalar common​

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

KbCategory.articles.first ● Int scalar common​

Returns the first n elements from the list.

KbCategory.articles.last ● Int scalar common​

Returns the last n elements from the list.

KbCategory.author ● Agent object common​

The author of the object.

KbCategory.coverImageUrl ● Url scalar common​

The URL of the category cover image.

KbCategory.createdAt ● DateTime! non-null scalar common​

The date and time that the object was created.

KbCategory.currentSlug ● String scalar common​

The current slug for the category.

KbCategory.description ● String scalar common​

A description of the object.

KbCategory.featured ● Boolean! non-null scalar common​

True if the object is set to be featured; false otherwise.

KbCategory.id ● ID! non-null scalar common​

KbCategory.knowledgeBase ● KnowledgeBase! non-null object common​

The Knowledge Base that the category belongs to to.

KbCategory.meta ● Meta object common​

The meta data of the object.

KbCategory.openGraph ● OpenGraph object common​

The Open Graph information of the object.

KbCategory.pageTitle ● String scalar common​

The HTML page title of the object.

KbCategory.position ● Int! non-null scalar common​

The position that the article should appear in when listed.

KbCategory.previousSlugs ● [String!]! non-null scalar common​

Historical slugs (oldest first), excluding the current slug.

KbCategory.publishedAt ● DateTime scalar common​

The date and time that the object was last published.

KbCategory.slug ● String scalar common​

The URL slug of the object.

KbCategory.state ● PublishState! non-null enum common​

The state of the object.

KbCategory.title ● String scalar common​

The title of the object.

KbCategory.updatedAt ● DateTime! non-null scalar common​

The date and time that the object was last updated.

KbCategory.updater ● Agent object common​

The agent that last updated the object.

Interfaces​

Node interface common​

An object with an ID.

Publishable interface common​

An object that can be published, for example Knowledge Base categories or articles.

For example:


    ... on Publishable {
      author {
        id
        email
      }
      description
      featured
      meta {
        description
        robots
      }
      openGraph {
        description
        imageUrl
        title
      }
      pageTitle
      position
      publishedAt
      slug
      state
      title
      updater {
        id
        email
      }
    }

Timestamped interface common​

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

Member of​

Article object ● KbCategoryConnection object ● KbCategoryEdge object