Ferndesk

Artículos

Obtener artículo por ID

Recupera un único artículo del centro de ayuda por su ID, incluyendo el contenido HTML renderizado y su URL canónica.

GET /articles/{id}

Obtener artículo por ID

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

Artículo

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 artículo de Ferndesk (art_...).

  • title string

    Título principal del artículo.

  • contentHtml string

    Contenido del artículo renderizado como HTML.

  • url string (uri) | null

    URL pública canónica para 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 colección para el artículo.

  • status string | null

    Estado de publicación del artículo.

  • publishedAt string | null

    Marca de tiempo de cuando se publicó el artículo.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.