Ferndesk

Secciones

Obtener sección por ID

Recupera una única sección por su ID, incluyendo todas las traducciones disponibles.

GET /sections/{id}

Obtener sección por ID

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

Path Parameters

  • id string obligatorio

    ID de recurso para 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 (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 localizada.

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