Buscar artículos

Búsqueda de texto completo en los artículos publicados. La clasificación reemplaza la paginación, por lo que next_cursor siempre es null.

GET /v1/articles/search

Token Bearer ámbito content:read

curl 'https://api.ferndesk.com/v1/articles/search?query=authentication&page_size=20&format=markdown' \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "results": [
    {
      "id": "art_01JXY9AZK4KV",
      "title": "Getting started with API keys",
      "slug": "getting-started-api-keys",
      "contentHtml": "<p>Welcome to the Ferndesk API.</p>",
      "contentMarkdown": "# Welcome to the Ferndesk API",
      "contentJson": {
        "type": "doc",
        "content": [
          {
            "type": "paragraph",
            "content": [
              {
                "type": "text",
                "text": "Welcome to Ferndesk."
              }
            ]
          }
        ]
      },
      "url": "https://docs.example.com/getting-started-api-keys-A1B2C3",
      "sectionId": "sect_01JXYA4T1JNT",
      "collectionId": "col_01JXYA6ABN52",
      "status": "published",
      "layout": "default",
      "publishedAt": "2026-01-15T18:25:43.511Z",
      "createdAt": "2026-01-15T18:25:43.511Z",
      "updatedAt": "2026-01-15T18:25:43.511Z"
    }
  ],
  "has_more": true,
  "next_cursor": "eyJ2IjoxLCJrIjpbIjIwMjYtMDEtMDEiLCJhcnRfMSJdfQ"
}

Artículos clasificados por relevancia

Parámetros de consulta

· 3

query string · min length: 1 obligatorio

Texto que se debe buscar.

page_size integer · min: 1· max: 100· por defecto: 20

Resultados clasificados por relevancia que se devolverán; la búsqueda clasifica como máximo 100 coincidencias y has_more indica cuándo se alcanza ese límite.

format string · por defecto: html· enumeración

Campo del cuerpo que se debe completar: contentHtml, contentMarkdown o el contentJson sin pérdida.

valores

html
markdown
json

Parámetros de consulta

Respuestas