Ferndesk

Articles

List articles

Returns all help center articles for your organization, ordered from newest to oldest. Each article includes rendered HTML content and a canonical URL for your help center.

GET /articles

List articles

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "contentHtml": "<string>",
      "url": "<url>",
      "sectionId": "<string>",
      "collectionId": "<string>",
      "status": "<string>",
      "publishedAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Paginated article response

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. Article payload returned by article endpoints.

    + Show Child Attributes
    • id string

      Ferndesk article ID (art_...).

    • title string

      Primary article title.

    • contentHtml string

      Article content rendered as HTML.

    • url string (uri) | null

      Canonical public URL for this article.

    • sectionId string | null

      Section ID containing the article.

    • collectionId string | null

      Optional collection grouping ID for the article.

    • status string | null

      Article publish status.

    • publishedAt string | null

      Timestamp when the article was published.

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