Ferndesk

Se devuelve cuando la clave de API no tiene el alcance requerido por un endpoint.

Listar colecciones

Devuelve las colecciones de tu centro de ayuda, comenzando por las más recientes y paginadas mediante cursor. Requiere el alcance content:read.

Alcance requerido: content:read

GET /collections

Listar colecciones

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

Desarrollo local

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página de configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance 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, anular 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

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la definición de alcances tienen alcances nulos = acceso total (modo heredado).

Query Parameters

  • page_size integer

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API llevan el prefijo fdsk_ y deben mantenerse en secreto. Puedes generar y administrar claves desde la página de configuración del desarrollador.

    Las claves pueden restringirse a cualquier subconjunto de estos alcances (cada endpoint indica el alcance 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, anular 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

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la definición de alcances tienen alcances nulos = acceso total (modo heredado). Ejemplo: 20

  • start_cursor string

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

Response

application/json
  • results[] object array

    Sobre de respuesta paginado mediante cursor (formato de Notion). Elementos de esta página.

    + Show Child Attributes
    • id string

      Carga útil de la colección.

    • helpdeskId string

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

    • sectionId string | null

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

    • parentCollectionId string | null

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

    • title string

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

    • subtitle string | null

      Título de la colección.

    • shortId string

      Subtítulo opcional de la colección.

    • createdAt string

      Identificador corto y comprensible para las personas.

    • updatedAt string

      Marca de tiempo ISO 8601 en UTC.

    • translations[] object arraydefault

      Marca de tiempo ISO 8601 en UTC. Default: [].

      + Show Child Attributes
      • id string

        Traducciones localizadas de la colección.

      • collectionId string

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

      • language string

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

      • title string

        Código de idioma de esta traducción.

      • subtitle string | null

        Título localizado de la colección.

      • status string

        Subtítulo localizado de la colección.

      • createdAt string

        Estado de la traducción.

      • updatedAt string

        Marca de tiempo ISO 8601 en UTC.

  • has_more boolean

    Marca de tiempo ISO 8601 en UTC.

  • next_cursor string | null

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