ReferenceWiKi API

Search & stats

Searching the wiki and usage statistics.

Method	Path	Summary
GET	`/v1/app/kb/me`	Current user's identity + personal space status (used by frontend)
GET	`/v1/app/kb/search`	Search published articles
GET	`/v1/app/kb/stats`	WiKi statistics

#Current user's identity + personal space status (used by frontend)

GET/v1/app/kb/me

Address: https://<your-org>.brambleit.cloud/api/v1/app/kb/me
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: WiKi.

Response 200

Field	Type	Description
`id`	integer
`name`	string
`email`	string
`isGlobalAdmin`	any
`personalSpace`	object, or null
`personalSpace.id`	integer
`personalSpace.slug`	string
`personalSpace.name`	string

Example response

JSON

{
  "id": 42,
  "name": "Example name",
  "email": "alex@example.com",
  "isGlobalAdmin": null,
  "personalSpace": {
    "id": 42,
    "slug": "example",
    "name": "Example name"
  }
}

Errors

Status	Message
404	User not found

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/kb/me' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/kb/me', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/kb/me",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/kb/me' -Headers $headers

#Search published articles

GET/v1/app/kb/search

Search published articles. Each result passes the same read check as GET /articles/:id (article, collection or space), so titles from spaces someone can't open never show (KB's own search and Bramble search, #82).

Address: https://<your-org>.brambleit.cloud/api/v1/app/kb/search
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: WiKi.

Query parameters

Name	Type	Description
`q`	any
`limit`	integer

Response 200

Field	Type	Description
`results`	array of any

Example response

JSON

{
  "results": []
}

Errors

Status	Message
400	Missing search query
404	User not found

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/kb/search' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/kb/search', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/kb/search",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/kb/search' -Headers $headers

#WiKi statistics

GET/v1/app/kb/stats

Address: https://<your-org>.brambleit.cloud/api/v1/app/kb/stats
Requires: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Licence: WiKi.

Response 200

Field	Type	Description
`spaces_count`	integer
`articles_count`	integer
`drafts_count`	integer

Example response

JSON

{
  "spaces_count": 3,
  "articles_count": 3,
  "drafts_count": 3
}

Errors

Status	Message
404	User not found

Example request

Bash

curl -X GET 'https://<your-org>.brambleit.cloud/api/v1/app/kb/stats' \
  -H "X-API-Key: $BRAMBLE_KEY"

JavaScript

const res = await fetch('https://<your-org>.brambleit.cloud/api/v1/app/kb/stats', {
  method: 'GET',
  headers: { 'X-API-Key': process.env.BRAMBLE_KEY },
});
const data = await res.json();

Python

import os, requests

r = requests.get(
    "https://<your-org>.brambleit.cloud/api/v1/app/kb/stats",
    headers={"X-API-Key": os.environ["BRAMBLE_KEY"]},
)
r.raise_for_status()
data = r.json()

PowerShell

$headers = @{ 'X-API-Key' = $env:BRAMBLE_KEY }
Invoke-RestMethod -Method GET -Uri 'https://<your-org>.brambleit.cloud/api/v1/app/kb/stats' -Headers $headers

Was this page helpful?