Ferndesk

Sections

List sections

Returns all sections in your help center, ordered by display position. Sections are the top-level navigation structure of your help center, and each section includes its available translations.

GET /sections

List sections

curl --request GET \
  --url 'https://api.ferndesk.com/v1/sections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "name": "<string>",
      "isDefault": true,
      "position": 1,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "translations": []
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Paginated sections

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. Section payload.

    + Show Child Attributes
    • id string

      Ferndesk section ID (sect_...).

    • helpdeskId string

      Ferndesk helpdesk ID (hd_...).

    • name string

      Section display name.

    • isDefault boolean

      Whether this section is the default section in the help center.

    • position integer

      Sort position used for section ordering.

    • createdAt string

      ISO 8601 timestamp in UTC.

    • updatedAt string

      ISO 8601 timestamp in UTC.

    • translations[] object arraydefault

      Localized section translations. Default: [].

      + Show Child Attributes
      • id string

        Section translation record ID.

      • sectionId string

        Ferndesk section ID (sect_...).

      • language string

        Language code for this translation.

      • name string

        Localized section name.

      • 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.