Ferndesk

Colecciones

Obtener una colección

Recuperar una colección individual con traducciones. Requiere el ámbito content:read.

Ámbito requerido: content:read

GET /collections/{id}

Obtener una colección

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 llevan el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página Configuración de desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos ámbitos (cada endpoint indica el ámbito que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, retirar, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves creadas antes de la definición de ámbitos tienen ámbitos nulos = acceso completo (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso solicitado. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string

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

  • helpdeskId string

    ID de helpdesk de Ferndesk (help_...).

  • 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 fácil de reconocer.

  • 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 colección de Ferndesk (col_...).

    • language string

      Código de idioma de esta traducción.

    • title string

      Título localizado de la colección.

    • subtitle string | null

      Subtítulo localizado de la colección.

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