Ferndesk

Secciones

Listar secciones

Devuelve las secciones de tu centro de ayuda ordenadas por posición de visualización y paginadas mediante cursor. Requiere el scope content:read.

Scope requerido: content:read

GET /sections

Listar secciones

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

Secciones paginadas mediante cursor

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 secretas. Puedes generar y administrar claves desde la página Configuración de desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope 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, dejar de publicar, 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 asignación de scopes tienen scopes nulos = acceso completo (modo heredado).

Query Parameters

  • page_size integer

    Número de elementos que se devolverán por página (1-100). Ejemplo: 20

  • start_cursor string

    Cursor de paginación opaco. Pasa el next_cursor de una respuesta anterior para obtener la página siguiente. Ejemplo: eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ

Response

application/json
  • results[] object array

    Elementos de esta página. Carga útil de la sección.

    + Show Child Attributes
    • id string

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

    • helpdeskId string

      ID del centro de ayuda de Ferndesk (help_...).

    • name string

      Nombre de visualización de la sección.

    • isDefault boolean

      Indica si esta sección 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 la 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.

  • has_more boolean

    Indica si hay más elementos disponibles después de esta página.

  • next_cursor string | null

    Cursor que se debe pasar como start_cursor para la página siguiente, o null en la última página.