Skip to main content
GET
/
knowledge
Retrieve knowledge base settings
curl --request GET \
  --url https://api.getfernand.com/knowledge \
  --header 'X-API-Key: <api-key>'
{
  "subdomain": "help",
  "custom_domain": "help.piedpiper.com",
  "favicon": "https://cdn.example.com/knowledge/uuid/images/favicon.png",
  "language": "en",
  "color_scheme": "light",
  "light_logo": "<string>",
  "light_accent_color": "#00a0ff",
  "dark_logo": "<string>",
  "dark_accent_color": "#00a0ff",
  "custom_css": "<string>",
  "custom_js": "<string>",
  "previous_url": "<string>",
  "valid_custom_domain": true,
  "last_verified_dns": "2023-11-07T05:31:56Z",
  "indexable": true,
  "title": "Help Center",
  "description": "Welcome to the PiedPiper help center",
  "company_name": "PiedPiper help center",
  "company_url": "https://piedpiper.com"
}
Returns the complete knowledge base configuration. The knowledge base serves as the central hub for managing help center content and appearance.

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 settings retrieved successfully.

Knowledge base settings combined with language-specific content. Inherits all properties from Knowledge model and adds language-specific fields.

​
subdomain
string | null

Subdomain for accessing the knowledge base (e.g., 'piedpiper' for piedpiper.fernand.help).

Maximum string length: 50
Example:

"help"

​
custom_domain
string | null

Custom domain configured for the knowledge base.

Maximum string length: 250
Example:

"help.piedpiper.com"

​
favicon
string | null

URL to the favicon image stored in CDN.

Maximum string length: 250
Example:

"https://cdn.example.com/knowledge/uuid/images/favicon.png"

​
language
string | null

Default language code for the knowledge base (null for browser detection).

Maximum string length: 5
Example:

"en"

​
color_scheme
enum<string> | null

Preferred color scheme for the knowledge base. Defaults to null, which will use the user system's preferences.

Available options:
light,
dark
Maximum string length: 5
​
light_logo
string | null

URL to the logo image for light mode.

Maximum string length: 250
​
light_accent_color
string

Hex color code for accent color in light mode.

Maximum string length: 7
Example:

"#00a0ff"

​
dark_logo
string | null

URL to the logo image for dark mode.

Maximum string length: 250
​
dark_accent_color
string

Hex color code for accent color in dark mode.

Maximum string length: 7
Example:

"#00a0ff"

​
custom_css
string | null

Custom CSS applied to the knowledge base.

​
custom_js
string | null

Custom JavaScript applied to the knowledge base.

​
previous_url
string | null

Previous URL if migrated from another help system.

Maximum string length: 250
​
valid_custom_domain
boolean

Whether the custom domain DNS is properly configured and verified.

​
last_verified_dns
string<date-time> | null

Timestamp of the last successful DNS verification.

​
indexable
boolean

Whether the knowledge base should be indexed by search engines.

​
title
string

Main title displayed on the knowledge base homepage.

Maximum string length: 250
Example:

"Help Center"

​
description
string | null

Description text shown on the knowledge base homepage.

Maximum string length: 1000
Example:

"Welcome to the PiedPiper help center"

​
company_name
string | null

Company name displayed in the knowledge base.

Maximum string length: 250
Example:

"PiedPiper help center"

​
company_url
string | null

Company website URL.

Maximum string length: 250
Example:

"https://piedpiper.com"