Leia as centrais de ajuda com a API Notiondesk

A API Notiondesk permite listar todas as centrais de ajuda em seu espaço de trabalho, ler a configuração de cada central de ajuda e verificar o status da sincronização agendada com o Notion. Comece aqui: a central de ajuda id retornada por essas rotas é a site_id que todas as outras rotas da API Notiondesk percorrem em seu caminho.

Na API Notiondesk, uma central de ajuda é chamada de site .

Liste seus centros de ajuda.

A lista inclui todos os centros de ajuda no espaço de trabalho que possuem sua chave, do mais antigo para o mais recente, usando paginação por cursor com page_size e 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
}

Gerencia várias centrais de ajuda? Consulte Criar várias centrais de ajuda .

Leia a configuração de uma central de ajuda.

A resposta descreve a central de ajuda e todas as configurações que a API pode alterar. Leia-a novamente após uma atualização de configurações para confirmar o novo estado: a resposta das rotas de configuração é 204 No Content sem corpo.

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"}
  ]
}

Verifique o status da sincronização agendada

A resposta é o mesmo status que o painel exibe para sincronizações agendadas:

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 execução possui started_at, finished_at (null enquanto estiver em execução e para uma execução que expirou), status (in_progress, success ou failed), um curto message e, para uma execução com falha:

Quando requires_customer_action for true, a próxima execução também falhará até que você corrija algum problema, como a conexão com o Notion. Consulte Como sincronizar sua central de ajuda com o Notion .

A lista de status de sincronização exibe apenas as execuções agendadas. Uma sincronização acionada pela API ou pelo painel não aparece em . Consulte Acionar sincronizações do Notion com a API Notiondesk para confirmar uma sincronização acionada.recent_runs

Erros

Cada rota também pode responder a invalid_version, authentication_error, rate_limited e internal_error. Consulte Erros de API, limites de taxa e novas tentativas de tratamento de Notiondesk .

Perguntas frequentes

O que vem a seguir?

• Leia artigos, coleções e entradas do changelog com a API Notiondesk

• O Trigger Notion sincroniza com a API Notiondesk

• Atualize as configurações da central de ajuda com a API Notiondesk