Ferndesk

Secciones

Obtener una sección

Recupera una única sección con traducciones. Requiere el ámbito content:read.

Ámbito requerido: content:read

GET /sections/{id}

Obtener una sección

curl --request GET \
  --url 'https://api.ferndesk.com/v1/sections/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "helpdeskId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "position": 1,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "translations": []
}

Secció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. Puedes generar y administrar claves desde la página Configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos ámbitos (cada endpoint indica el ámbito requerido 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 la publicación, 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 delimitación de ámbitos tienen null scopes = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

Response

application/json
  • id string

    ID de sección de Ferndesk (sect_...).

  • helpdeskId string

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

  • name string

    Nombre visible de la sección.

  • isDefault boolean

    Indica si esta es la sección predeterminada del centro de ayuda.

  • position integer

    Posición de ordenación utilizada para ordenar las secciones.

  • 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 sección. Default: [].

    + Show Child Attributes
    • id string

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

    • sectionId string

      ID de sección de Ferndesk (sect_...).

    • language string

      Código de idioma de esta traducción.

    • name string

      Nombre localizado de la secció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.