Skip to main content
GET
/
knowledge-bases
List knowledge bases
curl --request GET \
  --url https://api.awardee.dev/v1/knowledge-bases \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "total": 0,
  "page": 0,
  "page_size": 0,
  "data": [
    {
      "object": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "public_slug": "<string>",
      "description": "<string>",
      "logo_url": "<string>",
      "primary_color": "<string>",
      "is_published": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Send your API key as Authorization: Bearer aw_live_…. Manage keys in the dashboard under Settings → API Keys.

Query Parameters

​
page
integer
Required range: 1 <= x <= 9007199254740991
​
page_size
integer
Required range: 1 <= x <= 100
​
is_published
enum<string>

Filter to published / unpublished KBs.

Available options:
true,
false

Response

Knowledge bases

​
object
string
required
Allowed value: "list"
​
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
page
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
page_size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
data
object[]
required