Skip to content

Category tree for one language (hidden categories included)

GET
/knowledge-bases/{kbId}/categories
curl --request GET \
--url 'https://api.motenya.app/v1/knowledge-bases/example/categories?language=en' \
--header 'Authorization: Bearer <token>'

Requires categories:read.

kbId
required
string
>= 1 characters <= 64 characters
language
required

A language code enabled on the knowledge base, e.g. ‘en’ or ‘ro’.

string
>= 2 characters <= 16 characters

Example

en

A language code enabled on the knowledge base, e.g. ‘en’ or ‘ro’.

Top-level categories, children nested

Media typeapplication/json
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kbId
required
string
>= 1 characters <= 64 characters
language
required
string
parentId
required
string | null
>= 1 characters <= 64 characters
slug
required
string
name
required
string
description
required
string | null
icon
required
string | null
tags
required
Array<string>
hidden
required
boolean
translationGroupId
required
string | null
translations
required
Array<object>
object
language
required
string
slug
required
string
children
required

Child categories, recursively.

Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kbId
required
string
>= 1 characters <= 64 characters
language
required
string
parentId
required
string | null
>= 1 characters <= 64 characters
slug
required
string
name
required
string
description
required
string | null
icon
required
string | null
tags
required
Array<string>
hidden
required
boolean
translationGroupId
required
string | null
translations
required
Array<object>
object
language
required
string
slug
required
string
key
additional properties

Example generated

[
{
"id": "example",
"kbId": "example",
"language": "example",
"parentId": "example",
"slug": "example",
"name": "example",
"description": "example",
"icon": "example",
"tags": [
"example"
],
"hidden": true,
"translationGroupId": "example",
"translations": [
{
"language": "example",
"slug": "example"
}
],
"children": [
{
"id": "example",
"kbId": "example",
"language": "example",
"parentId": "example",
"slug": "example",
"name": "example",
"description": "example",
"icon": "example",
"tags": [
"example"
],
"hidden": true,
"translationGroupId": "example",
"translations": [
{
"language": "example",
"slug": "example"
}
]
}
]
}
]

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing, invalid, revoked or expired API key

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Missing scope, API turned off, published article without publish scope, or account suspended

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Not found, or outside the knowledge bases this key may use

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Slug or translation already exists

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rejected by validation (e.g. unknown language or category)

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Rate limited; see Retry-After

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
field
string
details
Array<object>
object
code
required
string
message
required
string
field
string

Example

{
"error": {
"code": "SLUG_TAKEN"
}
}

Internal error