Consulta tus centros de ayuda con la API Notiondesk

La API Notiondesk te permite listar todos los centros de ayuda en tu espacio de trabajo, leer la configuración de cada centro de ayuda y comprobar el estado de su sincronización programada con Notion. Empieza aquí: el centro de ayuda id que devuelven estas rutas es el site_id que todas las demás rutas de la API Notiondesk toman en su ruta.

En la API Notiondesk, un centro de ayuda se denomina sitio .

Enumera tus centros de ayuda

La lista incluye todos los centros de ayuda del espacio de trabajo que posee su clave, del más antiguo al más reciente, utilizando paginación por cursor con page_size y cursor.

curl "https://api.notiondesk.so/sites?page_size=50" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
      "full_domain": "help.example.com",
      "enabled": true,
      "default_locale": "en",
      "locales": ["en", "fr"]
    }
  ],
  "has_more": false,
  "next_cursor": null
}

¿Gestionas varios centros de ayuda? Consulta la sección Crear varios centros de ayuda .

Lea la configuración del centro de ayuda.

La respuesta describe el centro de ayuda y todas las configuraciones que la API puede modificar. Léala nuevamente después de actualizar la configuración para confirmar el nuevo estado: las rutas de configuración responden 204 No Content sin cuerpo.

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "id": "c74781f6-1aea-4e17-ab23-bbb8b4d174b6",
  "full_domain": "help.example.com",
  "enabled": true,
  "default_locale": "en",
  "access_mode": "public",
  "guest_access_requires_login": true,
  "supported_locales": ["en", "fr"],
  "available_locales": ["en", "fr", "de", "es"],
  "auto_sync_enabled": true,
  "seo_indexing_enabled": true,
  "setting_content_items": [
    {"locale": "en", "page_title": "Example Help Center", "page_description": "Answers about Example"}
  ],
  "auto_translate_enabled": false,
  "auto_translate_source_locale": null,
  "llms_txt_enabled": true,
  "markdown_export_enabled": true,
  "ai_contextual_menu_enabled": false,
  "mcp_search_enabled": true,
  "contact_form_enabled": true,
  "changelog_enabled": true,
  "changelog_email_subscriptions_enabled": false,
  "changelog_reactions_enabled": true,
  "changelog_email_subject_pattern": null,
  "changelog_categories": [
    {"category_id": "2984612035", "color": "blue_sky"}
  ]
}

Compruebe el estado de sincronización programada.

La respuesta es el mismo estado que muestra el panel de control para las sincronizaciones programadas:

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/sync-status" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "auto_sync_enabled": true,
  "frequency": "daily",
  "next_sync_at": "2026-10-19T06:00:00+00:00",
  "current_status": "idle",
  "recent_runs": [
    {
      "started_at": "2026-10-18T06:00:02+00:00",
      "finished_at": "2026-10-18T06:01:41+00:00",
      "status": "success",
      "message": "Synced successfully.",
      "error_category": null,
      "requires_customer_action": false
    }
  ]
}

Cada ejecución tiene started_at, finished_at (null mientras se ejecuta y para una ejecución que expiró), status (in_progress, success o failed), un breve message y para una ejecución fallida:

Cuando requires_customer_action es true, la siguiente ejecución también falla hasta que soluciones algún problema, como la conexión con Notion. Consulta Cómo sincronizar tu centro de ayuda con Notion .

El estado de sincronización muestra únicamente las ejecuciones programadas. Una sincronización que actives a través de la API o el panel de control no aparecerá en esta lista. Consulta la sección «Activar sincronizaciones de Notion con la API Notiondesk» para confirmar una sincronización activada.recent_runs

Errores

Cada ruta también puede responder a invalid_version, authentication_error, rate_limited y internal_error. Consulte Manejo de errores de API, límites de velocidad y reintentos de Notiondesk .

Preguntas frecuentes

¿Qué sigue?

• Lee artículos, colecciones y entradas del registro de cambios con la API Notiondesk

• Trigger Notion se sincroniza con la API Notiondesk

• Actualiza la configuración del centro de ayuda con la API Notiondesk