Ferndesk

Secciones

Listar secciones

Devuelve todas las secciones de su centro de ayuda, ordenadas por posición de visualización. Las secciones son la estructura de navegación de nivel superior de su centro de ayuda, y cada sección incluye sus traducciones disponibles.

GET /sections

Listar secciones

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

Secciones paginadas

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.

Query Parameters

  • limit integer

    Número máximo de elementos a devolver (1-100). Ejemplo: 20

  • offset integer

    Número de elementos a omitir antes de recopilar los resultados. Ejemplo: 0

Response

application/json
  • items[] object array

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

    + Show Child Attributes
    • id string

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

    • helpdeskId string

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

    • name string

      Nombre de visualización de la sección.

    • isDefault boolean

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

    • position integer

      Posición de clasificación utilizada para el orden de las secciones.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.

    • translations[] object arraydefault

      Traducciones de secciones localizadas. 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 para esta traducción.

      • name string

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

  • limit integer

    Tamaño de página utilizado para esta respuesta.

  • offset integer

    Número de registros omitidos para esta página.

  • total integer

    Total de registros coincidentes en todas las páginas.