Ferndesk

Collections

Récupérer une collection par ID

Récupère une seule collection par son ID, incluant toutes les traductions disponibles.

GET /collections/{id}

Récupérer une collection par 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 requis header

    Toutes les requêtes nécessitent un jeton Bearer dans l'en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page des Paramètres développeur.

Path Parameters

  • id string requis

    ID de ressource pour l'entité demandée. Exemple: art_01JXY9AZK4KV

Response

application/json
  • id string

    ID de collection Ferndesk (col_...).

  • helpdeskId string

    ID de helpdesk Ferndesk (hd_...).

  • sectionId string | null

    ID de la section parente pour cette collection.

  • parentCollectionId string | null

    ID de la collection parente si elle est imbriquée.

  • title string

    Titre de la collection.

  • subtitle string | null

    Sous-titre optionnel de la collection.

  • shortId string

    Identifiant court lisible par l'homme.

  • createdAt string

    Horodatage ISO 8601 en UTC.

  • updatedAt string

    Horodatage ISO 8601 en UTC.

  • translations[] object arraydefault

    Traductions localisées de la collection. Default: [].

    + Show Child Attributes
    • id string

      ID de l'enregistrement de traduction de la collection.

    • collectionId string

      ID de collection Ferndesk (col_...).

    • language string

      Code de langue pour cette traduction.

    • title string

      Titre localisé de la collection.

    • subtitle string | null

      Sous-titre localisé de la collection.

    • status string

      Statut de la traduction.

    • createdAt string

      Horodatage ISO 8601 en UTC.

    • updatedAt string

      Horodatage ISO 8601 en UTC.