Ferndesk

Collections

List collections

Returns all collections in your help center, ordered from newest to oldest. Collections group related articles together within a section, and each collection includes its available translations.

GET /collections

List collections

curl --request GET \
  --url 'https://api.ferndesk.com/v1/collections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "sectionId": "<string>",
      "parentCollectionId": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "shortId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "translations": []
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Paginated collections

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

Query Parameters

  • limit integer

    Maximum number of items to return (1-100). Example: 20

  • offset integer

    Number of items to skip before collecting results. Example: 0

Response

application/json
  • items[] object array

    Current page items. Collection payload.

    + Show Child Attributes
    • id string

      Ferndesk collection ID (col_...).

    • helpdeskId string

      Ferndesk helpdesk ID (hd_...).

    • sectionId string | null

      Parent section ID for this collection.

    • parentCollectionId string | null

      Parent collection ID if this is nested.

    • title string

      Collection title.

    • subtitle string | null

      Optional collection subtitle.

    • shortId string

      Short human-friendly identifier.

    • createdAt string

      ISO 8601 timestamp in UTC.

    • updatedAt string

      ISO 8601 timestamp in UTC.

    • translations[] object arraydefault

      Localized collection translations. Default: [].

      + Show Child Attributes
      • id string

        Collection translation record ID.

      • collectionId string

        Ferndesk collection ID (col_...).

      • language string

        Language code for this translation.

      • title string

        Localized collection title.

      • subtitle string | null

        Localized collection subtitle.

      • status string

        Translation status.

      • createdAt string

        ISO 8601 timestamp in UTC.

      • updatedAt string

        ISO 8601 timestamp in UTC.

  • limit integer

    Page size used for this response.

  • offset integer

    Number of skipped records for this page.

  • total integer

    Total matching records across all pages.