Skip to content

List articles in one language (all statuses), newest first

GET
/knowledge-bases/{kbId}/articles
curl --request GET \
--url 'https://api.motenya.app/v1/knowledge-bases/example/articles?language=en&status=draft&limit=25&offset=0' \
--header 'Authorization: Bearer <token>'

Requires articles:read. Items omit the body; fetch an article for it.

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’.

status
string
Allowed values: draft published archived
categoryId
string
>= 1 characters <= 64 characters
tag
string
<= 50 characters
q

Full-text search over title and body.

string
<= 200 characters

Full-text search over title and body.

limit
integer
default: 25 >= 1 <= 100
offset
integer | null
0

A page of articles

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
>= 1 characters <= 64 characters
kbId
required
string
>= 1 characters <= 64 characters
language
required
string
categoryId
required
string | null
>= 1 characters <= 64 characters
slug
required
string
title
required
string
excerpt
required
string | null
tags
required
Array<string>
status
required
string
Allowed values: draft published archived
translationGroupId
required
string | null
publishedAt
required
string | null
updatedAt
required
string
total
required
integer

Example

{
"items": [
{
"status": "draft"
}
]
}

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