Skip to main content
GET
/
knowledge
/
links
List links
curl --request GET \
  --url https://api.getfernand.com/knowledge/links \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "sort": 1,
    "url": "https://piedpiper.com/contact",
    "target": "_blank",
    "position": "HEADER",
    "title": "Contact Us"
  }
]
Returns all navigation links configured for the specified position (HEADER or FOOTER) in the knowledge base. Links are returned in sort order. These links appear in the knowledge base navigation to provide quick access to external resources or important pages. Links are language-specific based on the default language setting.

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.

Query Parameters

​
position
enum<string>
required

Position where links should be displayed (case-insensitive).

Available options:
HEADER,
FOOTER

Response

200 - application/json

Links retrieved successfully.

​
id
integer<int64>

Unique identifier for the link.

​
sort
integer

Sort order within the position (HEADER or FOOTER).

Example:

1

​
url
string

Destination URL for the link.

Maximum string length: 250
Example:

"https://piedpiper.com/contact"

​
target
enum<string>

Link target behavior - _blank for new tab, _self for same window.

Available options:
_blank,
_self
Maximum string length: 6
Example:

"_blank"

​
position
enum<string>

Where the link is displayed in the knowledge base.

Available options:
HEADER,
FOOTER
Maximum string length: 6
Example:

"HEADER"

​
title
string

Display text for the link shown in navigation.

Maximum string length: 250
Example:

"Contact Us"