Skip to main content
GET
Retrieve the complete knowledge base structure

Authorizations

X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Response

Knowledge base structure retrieved successfully.

base_url
string

Base URL of the knowledge base (either custom domain or subdomain).

Example:

"https://help.piedpiper.com"

articles
object

Map of article IDs to article objects with metadata and computed URLs.

collections
object

Map of collection IDs to collection objects with their articles.