Sites

Get a site

Reads a site and its settings: access, languages, sync, translation, AI features, contact form and changelog.

GET
/sites/{site_id}
cURL
curl --request GET \
  --url 'https://api.notiondesk.so/sites/{site_id}' \
  --header 'Authorization: Bearer <token>'

Autorizaciones

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Parámetros de ruta

  • site_idstringobligatorio

    The id of a site from List sites.

Encabezados

  • nd-versionstring

    The contract version your integration was written against. Without it, the request uses the current version. An unknown value answers 400 invalid_version.

Respuestas

The site.

Encabezados

  • nd-versionstring

    The contract version that answered the request.

  • X-RateLimit-Limitinteger

    Requests allowed per minute: 120 for GET, 20 for writes, per key or OAuth grant.

  • X-RateLimit-Remaininginteger

    Requests left in the current window.

  • Retry-Afterinteger

    Seconds until the next request is accepted; 0 while requests remain.

  • idstringobligatorio

    The site identifier.

  • full_domainstring | nullobligatorio

    The domain readers visit: the custom domain when one is active, otherwise the Notiondesk subdomain.

  • enabledbooleanobligatorio

    Whether the site is enabled.

  • default_localestringobligatorio

    The site's default language, for example en.

  • access_modestring | nullobligatorio

    Who can read the site.

  • guest_access_requires_loginbooleanobligatorio

    Whether guest-account sites ask readers to sign in.

  • supported_localesstring[]obligatorio

    The languages the site serves, default first, limited to your plan's language allowance.

  • available_localesstring[]obligatorio

    Every language a site can be configured to serve.

  • auto_sync_enabledbooleanobligatorio

    Whether the site syncs from its source on a schedule.

  • seo_indexing_enabledbooleanobligatorio

    Whether search engines may index the site.

  • setting_content_itemsobject[]obligatorio

    The page title and description per enabled language.

    • localestringobligatorio
    • page_titlestring | nullobligatorio
    • page_descriptionstring | nullobligatorio
  • auto_translate_enabledbooleanobligatorio

    Whether missing translations are produced automatically.

  • auto_translate_source_localestring | nullobligatorio

    The language automatic translation reads from.

  • llms_txt_enabledbooleanobligatorio

    Whether the site publishes llms.txt.

  • markdown_export_enabledbooleanobligatorio

    Whether articles can be read as markdown.

  • ai_contextual_menu_enabledbooleanobligatorio

    Whether articles show the AI contextual menu.

  • mcp_search_enabledbooleanobligatorio

    Whether the site's public MCP search is on.

  • contact_form_enabledbooleanobligatorio

    Whether the site shows its contact form. While the workspace has the Service Desk Inbox enabled, every site shows it whatever this value holds.

  • changelog_enabledbooleanobligatorio

    Whether the changelog is published.

  • changelog_email_subscriptions_enabledbooleanobligatorio

    Whether readers can subscribe to changelog emails.

  • changelog_reactions_enabledbooleanobligatorio

    Whether readers can react to changelog entries.

  • changelog_email_subject_patternstring | nullobligatorio

    The subject line pattern of changelog emails.

  • changelog_categoriesobject[]obligatorio

    The changelog categories.

    • category_idstringobligatorio
    • colorstring | nullobligatorio