Skip to main content
GET
/
api
/
v1
/
knowledge
curl -X GET "https://your-domain.com/api/v1/knowledge/?page=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "items": [
    {
      "id": "kb_123abc",
      "name": "Product Documentation",
      "description": "Knowledge base for product documentation and guides",
      "user_id": "user_456def",
      "data": {},
      "write_access": true,
      "created_at": 1678901234,
      "updated_at": 1678901234
    },
    {
      "id": "kb_789xyz",
      "name": "Technical Support",
      "description": "Support articles and troubleshooting guides",
      "user_id": "user_456def",
      "data": {},
      "write_access": false,
      "created_at": 1678905678,
      "updated_at": 1678905678
    }
  ],
  "total": 2
}
Retrieve a paginated list of knowledge bases accessible to the authenticated user. Results include metadata about each knowledge base and the user’s write access permissions.

​
Request

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination (minimum: 1)

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Response

​
items
array
Array of knowledge base objects with access information
​
id
string
Unique identifier for the knowledge base
​
name
string
Display name of the knowledge base
​
description
string
Description of the knowledge base content
​
user_id
string
ID of the user who created the knowledge base
​
data
object
Additional metadata about the knowledge base
​
write_access
boolean
Whether the current user has write permissions
​
created_at
integer
Unix timestamp when the knowledge base was created
​
updated_at
integer
Unix timestamp when the knowledge base was last updated
​
total
integer
Total number of knowledge bases accessible to the user
curl -X GET "https://your-domain.com/api/v1/knowledge/?page=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "items": [
    {
      "id": "kb_123abc",
      "name": "Product Documentation",
      "description": "Knowledge base for product documentation and guides",
      "user_id": "user_456def",
      "data": {},
      "write_access": true,
      "created_at": 1678901234,
      "updated_at": 1678901234
    },
    {
      "id": "kb_789xyz",
      "name": "Technical Support",
      "description": "Support articles and troubleshooting guides",
      "user_id": "user_456def",
      "data": {},
      "write_access": false,
      "created_at": 1678905678,
      "updated_at": 1678905678
    }
  ],
  "total": 2
}

​
Search Knowledge Bases

You can also search knowledge bases using the search endpoint: 
GET /api/v1/knowledge/search?query=<search_term>&page=1

​
Search Query Parameters

​
query
string
Search term to filter knowledge bases
​
view_option
string
Filter by view option (e.g., “shared”, “owned”)
​
page
integer
default:"1"
Page number for pagination

​
Notes

  • Results are paginated with 30 items per page (PAGE_ITEM_COUNT)
  • Only knowledge bases accessible to the user are returned (based on permissions and group membership)
  • Admin users with BYPASS_ADMIN_ACCESS_CONTROL can see all knowledge bases
  • The write_access field indicates whether the user can modify the knowledge base