Skip to main content
GET
/
knowledge
/
structure
Retrieve the complete knowledge base structure
curl --request GET \
  --url https://api.getfernand.com/knowledge/structure \
  --header 'X-API-Key: <api-key>'
{
  "base_url": "https://help.piedpiper.com",
  "articles": {},
  "collections": {}
}
Returns the full hierarchical structure of the knowledge base. Collections are organized in a tree structure where collections can contain articles and nested sub-collections. The structure includes computed URLs for all articles based on their collection path. Note that some collections may have zero articles but serve as parent containers for nested collections.

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.