Knowledge base pages API

Knowledge base pages are the published versions of pages that are part of a knowledge base. A knowledge base must be enabled in order to access its pages.

Search documents in a knowledge base

GET /api/v1/knowledge_bases/:knowledge_base_id/pages

Parameters
NameDescription
knowledge_base_id *

Numeric ID of the knowledge base

q

Search term to match against documents

Example request

GET /api/v1/knowledge_bases/701841993/pages?q=first

Example CURL command

curl -g "https://company.aha.io/api/v1/knowledge_bases/701841993/pages?q=first" -X GET \
	-H "Authorization: Bearer 31dc1cce73b8ee8c7560aed54e39e8b0ee347333cd9d5db03a55a3cf953a9874" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 31dc1cce73b8ee8c7560aed54e39e8b0ee347333cd9d5db03a55a3cf953a9874
contentType: application/json
accept: application/json

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body