api
Get started with the Notiondesk REST APIUse the Notiondesk REST API to read help center content, manage redirects and settings, pull analytics, and trigger Notion syncs from code.
Authenticate with the Notiondesk API using API keysCreate a Notiondesk API key, pick read, write, sync or admin scopes, and authenticate REST API requests with a bearer token. Rotate or revoke anytime.
Connect your app to Notiondesk with OAuthBuild a Notiondesk OAuth app: register a client, run the OAuth 2.0 authorization code flow with PKCE, refresh tokens, and call the REST API.
Paginate and version Notiondesk API requestsPage through Notiondesk API lists with page_size and cursor, pin a version with the nd-version header, and use snake_case field names.
Handle Notiondesk API errors, rate limits, and retriesNotiondesk API error codes and envelope, rate limits of 120 reads and 20 writes per minute, Retry-After, and safe retries with Idempotency-Key.
Read your help centers with the Notiondesk APIList your Notiondesk help centers, read their domain, languages and settings, and check scheduled Notion sync status with the Notiondesk API.
Read articles, collections, and changelog entries with the Notiondesk APIRead Notiondesk help center articles and collections as markdown, in any language, with sync state, and list changelog entries via the REST API.
Trigger Notion syncs with the Notiondesk APISync your Notiondesk help center from Notion through the API: trigger a site, collection or article sync, and turn scheduled sync on or off.
Manage page redirects with the Notiondesk APICreate, list, update and delete Notiondesk help center page redirects through the REST API. Bulk-import old URLs after a migration.
Manage languages and automatic translation with the Notiondesk APIAdd or remove help center languages, set the default language, and turn Notiondesk automatic AI translation on or off through the REST API.
Update help center settings with the Notiondesk APIUpdate Notiondesk help center settings via the REST API: SEO indexing, page titles, llms.txt and markdown export, the contact form, and changelogs.
Customize help center branding and themes with the Notiondesk APIUpdate Notiondesk help center branding through the REST API: colors, fonts, layout, header and footer links, search display, and themes.
Manage help center integrations with the Notiondesk APIConfigure Google Analytics, Plausible, Umami, Intercom, Crisp, Help Scout and Google Tag Manager on your Notiondesk help center via the REST API.
Get help center analytics with the Notiondesk APIExport Notiondesk help center analytics via the REST API: visitors, article views, top searches, searches with no results, and reader reactions.
Export reader feedback with the Notiondesk APIExport Notiondesk article feedback via the REST API: reader reactions, follow-up answers, messages and attachments, newest first.
Automate common help center tasks with the Notiondesk APINotiondesk API examples: sync from GitHub Actions, back up articles as markdown, post feedback to Slack, and report searches with no results.