Ferndesk

Colecciones

Listar colecciones

Devuelve todas las colecciones de su centro de ayuda, ordenadas de la más reciente a la más antigua. Las colecciones agrupan artículos relacionados dentro de una sección, y cada colección incluye sus traducciones disponibles.

GET /collections

Listar colecciones

curl --request GET \
  --url 'https://api.ferndesk.com/v1/collections' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "items": [
    {
      "id": "<string>",
      "helpdeskId": "<string>",
      "sectionId": "<string>",
      "parentCollectionId": "<string>",
      "title": "<string>",
      "subtitle": "<string>",
      "shortId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "translations": []
    }
  ],
  "limit": 1,
  "offset": 1,
  "total": 1
}

Colecciones 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 colección.

    + Show Child Attributes
    • id string

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

    • helpdeskId string

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

    • 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 amigable para humanos.

    • createdAt string

      Marca de tiempo ISO 8601 en UTC.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.

    • translations[] object arraydefault

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

      • title string

        Título de la colección localizado.

      • subtitle string | null

        Subtítulo de la colecció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.