Knowledge Base API

Search articles, manage categories, and track analytics.

GET/api/v1/kb/search

Search knowledge base articles by query.

Authentication

Include your API key in the X-API-Key header. Get your key at app.reechdesk.com/settings.

query parameters

Name	Type	Required	Description
q	string	required	Search query string
entityId	string	required	Entity to search within
limit	number	optional	Max results (default: 10, max: 50)

curl -H "X-API-Key: rd_test_your_key" \
  "https://your-domain.com/api/v1/kb/search?q=reset+password&entityId=cashmatrix"

Response200

json

[
  {
    "id": "art_001",
    "title": "How to reset your password",
    "slug": "reset-password",
    "excerpt": "Follow these steps to reset your password...",
    "category": {
      "name": "Account",
      "slug": "account"
    }
  }
]

GET/api/v1/kb/articles

List all published articles for an entity.

Authentication

Include your API key in the X-API-Key header. Get your key at app.reechdesk.com/settings.

query parameters

Name	Type	Required	Description
entityId	string	required	Entity ID
categoryId	string	optional	Filter by category ID
limit	number	optional	Max results (default: 20, max: 100)
offset	number	optional	Pagination offset

curl -H "X-API-Key: rd_test_your_key" \
  "https://your-domain.com/api/v1/kb/articles?entityId=cashmatrix&categoryId=cat_001&limit=20"

Response200

json

{
  "data": [
    {
      "id": "art_001",
      "title": "How to reset your password",
      "slug": "reset-password",
      "excerpt": "Follow these steps to reset your password...",
      "categoryId": "cat_001",
      "isPublished": true,
      "createdAt": "2026-06-01T00:00:00Z"
    }
  ],
  "total": 8,
  "limit": 20,
  "offset": 0
}

POST/api/v1/kb/articles

Create a new knowledge base article.

Authentication

Include your API key in the X-API-Key header. Get your key at app.reechdesk.com/settings.

body parameters

Name	Type	Required	Description
title	string	required	Article title
slug	string	required	URL slug (auto-generated from title if omitted)
content	string	required	Article content (Markdown)
categoryId	string	required	Category ID to file under
entityId	string	required	Entity this article belongs to
isPublished	boolean	optional	Publish immediately (default: false)

curl -X POST https://your-domain.com/api/v1/kb/articles \
  -H "X-API-Key: rd_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "How to export data",
    "slug": "export-data",
    "content": "# Exporting Data\n\nYou can export your data from Settings...",
    "categoryId": "cat_001",
    "entityId": "cashmatrix",
    "isPublished": true
  }'

Request

json

{
  "title": "How to export data",
  "slug": "export-data",
  "content": "# Exporting Data\n\nYou can export your data from Settings...",
  "categoryId": "cat_001",
  "entityId": "cashmatrix",
  "isPublished": true
}

Response201

json

{
  "id": "art_new001",
  "title": "How to export data",
  "slug": "export-data",
  "categoryId": "cat_001",
  "isPublished": true,
  "createdAt": "2026-06-21T10:00:00Z"
}

GET/api/v1/kb/categories

List all categories for an entity.

Authentication

Include your API key in the X-API-Key header. Get your key at app.reechdesk.com/settings.

query parameters

Name	Type	Required	Description
entityId	string	required	Entity ID

curl -H "X-API-Key: rd_test_your_key" \
  "https://your-domain.com/api/v1/kb/categories?entityId=cashmatrix"

Response200

json

{
  "data": [
    {
      "id": "cat_001",
      "name": "Getting Started",
      "slug": "getting-started",
      "articleCount": 5
    },
    {
      "id": "cat_002",
      "name": "Account",
      "slug": "account",
      "articleCount": 8
    }
  ]
}

POST/api/v1/kb/articles/:id/helpful

Record a helpfulness vote for an article.

Authentication

Include your API key in the X-API-Key header. Get your key at app.reechdesk.com/settings.

path parameters

Name	Type	Required	Description
id	string	required	Article ID

body parameters

Name	Type	Required	Description
helpful	boolean	required	true if helpful, false if not

curl -X POST https://your-domain.com/api/v1/kb/articles/art_001/helpful \
  -H "X-API-Key: rd_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "helpful": true }'

Request

json

{
  "helpful": true
}

Response200

json

{
  "recorded": true
}

Track helpfulness

Use this endpoint to record "Was this helpful?" votes. This helps identify articles that need improvement.