Ferndesk

Collections

Get collection by ID

Retrieve a single collection by its ID, including all available translations.

GET /collections/{id}

Get collection by ID

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

Collection

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.

Path Parameters

  • id string required

    Resource ID for the requested entity. Example: art_01JXY9AZK4KV

Response

application/json
  • 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.