Ferndesk

Colecciones

Obtener colección por ID

Recupera una sola colección por su ID, incluyendo todas las traducciones disponibles.

GET /collections/{id}

Obtener colección por 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": []
}

Colección

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

Path Parameters

  • id string obligatorio

    ID del recurso para la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string

    ID de la colección de Ferndesk (col_...).

  • helpdeskId string

    ID del helpdesk de Ferndesk (hd_...).

  • sectionId string | null

    ID de la sección principal de esta colección.

  • parentCollectionId string | null

    ID de la colección principal si está anidada.

  • title string

    Título de la colección.

  • subtitle string | null

    Subtítulo opcional de la colección.

  • shortId string

    Identificador corto y amigable para humanos.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.

  • translations[] object arraydefault

    Traducciones localizadas de la colección. Default: [].

    + Show Child Attributes
    • id string

      ID del registro de traducción de la colección.

    • collectionId string

      ID de la colección de Ferndesk (col_...).

    • language string

      Código de idioma para esta traducción.

    • title string

      Título de la colección localizado.

    • subtitle string | null

      Subtítulo de la colección localizado.

    • status string

      Estado de la traducción.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.