Skip to main content
GET
/
knowledge
/
collections
List collections
curl --request GET \
  --url https://api.getfernand.com/knowledge/collections \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 123,
    "parent_id": 123,
    "title": "Getting Started",
    "slug": "getting-started",
    "description": "Essential guides to help you get started with our platform",
    "seo_title": "Getting Started - Complete Guide",
    "seo_description": "<string>",
    "icon": "🚀",
    "get_icon_color": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "last_updated": "2023-11-07T05:31:56Z",
    "get_articles": [
      12,
      45,
      67
    ],
    "get_collections": [
      3,
      8,
      15
    ],
    "sort": 2
  }
]
Returns all collections in the knowledge base, optionally filtered by parent collection. Collections are returned in sort order. When parent_id is provided, only direct children of that collection are returned. Without parent_id, all collections across all levels are returned. Collections organize articles into hierarchical categories for better content organization and navigation.

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

​
parent_id
integer | null

Filter collections by parent ID. Omit to get all collections, or provide a collection ID to get its children, or null to get root-level collections.

Response

200 - application/json

Collections retrieved successfully.

​
id
integer<int64>

Unique identifier for the collection.

​
parent_id
integer | null

ID of the parent collection for nested organization (null for root-level collections).

​
title
string

Display title of the collection shown in navigation and headers.

Maximum string length: 250
Example:

"Getting Started"

​
slug
string

URL-safe slug used in the collection's URL path.

Maximum string length: 250
Example:

"getting-started"

​
description
string | null

Description of the collection content and purpose.

Example:

"Essential guides to help you get started with our platform"

​
seo_title
string

SEO-optimized title for search engines and meta tags.

Maximum string length: 250
Example:

"Getting Started - Complete Guide"

​
seo_description
string | null

SEO-optimized description for search engines and social media previews.

Maximum string length: 250
​
icon
string | null

Emoji icon identifier displayed alongside the collection title for visual distinction.

Maximum string length: 25
Example:

"🚀"

​
get_icon_color
string | null

Computed color code associated with the emoji icon for theming purposes.

​
created
string<date-time>

Timestamp when the collection was created.

​
last_updated
string<date-time>

Timestamp when the collection was last modified.

​
get_articles
integer[]

Array of article IDs contained directly in this collection (not including nested collections).

Example:
[12, 45, 67]
​
get_collections
integer[]

Array of sub-collection IDs that are children of this collection.

Example:
[3, 8, 15]
​
sort
integer

Sort order within the parent collection or at root level.

Example:

2