Ferndesk

Artículos

Obtener un artículo

Recupera un único artículo publicado del centro de ayuda por su ID. Usa format=markdown para obtener contenido en Markdown.

Scope requerido: content:read

GET /articles/{id}

Obtener un artículo

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "title": "<string>",
  "slug": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>"
}

Artículo

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 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, retirar la publicación, restaurar y eliminar contenido (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 null = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso solicitado. Ejemplo: art_01JXY9AZK4KV

Query Parameters

  • format string enum

    Formato de representación del contenido. html (predeterminado) devuelve contentHtml; markdown devuelve contentMarkdown; json devuelve contentJson: el documento ProseMirror/Tiptap sin procesar almacenado. El JSON usa el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps y cards) y es la representación sin pérdida del cuerpo del artículo. Ejemplo: markdown

Response

application/json
  • id string

    ID del artículo de Ferndesk (art_...).

  • title string

    Título principal del artículo.

  • slug string | null

    Slug de URL del artículo.

  • contentHtml string

    Contenido del artículo renderizado como HTML. Está presente cuando format=html (predeterminado).

  • contentMarkdown string

    Contenido del artículo renderizado como Markdown. Está presente cuando format=markdown.

  • contentJson any | null

    Documento ProseMirror/Tiptap sin procesar almacenado. Está presente cuando format=json. Usa el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps y cards) y es la representación sin pérdida.

  • url string (uri) | null

    URL pública canónica de este artículo.

  • sectionId string | null

    ID de la sección que contiene el artículo.

  • collectionId string | null

    ID opcional de agrupación de la colección del artículo.

  • status string | null

    Estado de publicación del artículo.

  • publishedAt string | null

    Marca de tiempo de publicación del artículo.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.