Branding

Get customize settings

Reads a site's branding: colours, fonts, layout, header, footer, links and theme. It returns exactly the fields Update customize settings accepts; custom code and media are dashboard-only.

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

認可

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

パスパラメータ

  • site_idstring必須

    The id of a site from List sites.

ヘッダー

  • 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.

レスポンス

The site's branding.

ヘッダー

  • 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.

  • colorsobject | null必須

    The site colours. A colour you leave out keeps its value, and null leaves them unchanged.

    • primarystring
    • textstring
    • linkstring
    • link_hoverstring
    • headerstring
    • header_topstring
    • header_textstring
    • header_top_textstring
    • header_linkstring
    • header_link_hoverstring
    • backgroundstring
    • footer_backgroundstring
    • footer_textstring
    • article_card_backgroundstring
    • collection_card_backgroundstring
    • aside_menu_textstring
    • aside_menu_text_hoverstring
    • aside_menu_background_hoverstring
    • dark
  • appearanceobject | null必須

    The colour mode readers get. null leaves it unchanged.

    • defaultstring | null
    • strictboolean
  • layout_collectionstring必須
  • layout_articlestring必須
  • primary_fontstring | null必須
  • secondary_fontstring | null必須
  • header_variantstring | null必須
  • headline_sizestring | null必須
  • header_background_typestring | null必須
  • header_gradient_typestring | null必須
  • header_gradient_angleinteger | null必須
  • header_gradient_colorsobject[]必須
    • colorstring

      A #rrggbb hexadecimal colour.

    • positioninteger | null
  • header_shape_typestring | null必須

    Advanced customization.

  • header_linksobject[]必須
    • titlestring | null
    • urlstring | null
  • header_link_translationsobject[]必須
    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • homepage_linkstring | null必須
  • homepage_link_translationsobject[]必須
    • localestring | null
    • valuestring | null
  • search_bar_lengthstring必須
  • search_bar_alignmentstring必須
  • search_bar_corner_stylestring必須
  • search_bar_shadowstring | null必須
  • search_result_variantstring | null必須
  • instant_searchboolean必須

    Advanced customization.

  • segmented_search_resultsboolean必須

    Advanced customization.

  • ai_search_enabledboolean必須
  • ai_search_display_modestring | null必須

    Advanced customization.

  • ai_search_aside_positionstring | null必須

    Advanced customization.

  • collections_stylestring必須
  • collection_card_corner_stylestring必須
  • collection_section_variantstring | null必須
  • collection_content_variantstring | null必須
  • collapsable_sub_categoriesboolean必須
  • collapsable_sub_categories_default_statestring必須
  • show_collection_iconsboolean必須
  • show_collection_descriptionsboolean必須
  • show_collection_contentboolean必須
  • show_collection_authorsboolean必須
  • show_collection_articles_countboolean必須
  • articles_stylestring必須
  • article_card_corner_stylestring必須
  • content_tabs_stylestring | null必須

    null leaves it unchanged.

  • article_footer_variantstring | null必須
  • table_of_contents_positionstring必須
  • show_table_of_contentsboolean必須
  • show_article_iconsboolean必須
  • show_article_descriptionsboolean必須
  • show_article_authorsboolean必須
  • show_related_articlesboolean必須
  • show_breadcrumb_iconboolean | null必須

    null for a site that never set it.

  • show_article_publish_dateboolean必須

    Advanced customization.

  • show_article_page_authorboolean必須

    Advanced customization.

  • show_article_feedback_formboolean | null必須

    Advanced customization. null for a site that never set it.

  • require_email_for_article_feedbackboolean | null必須

    Advanced customization. null for a site that never set it.

  • feedback_reaction_stylestring | null必須

    Advanced customization.

  • feedback_question_labelstring | null必須

    Advanced customization.

  • feedback_comment_modestring | null必須

    Advanced customization.

  • aside_menu_expansion_modestring | null必須

    Advanced customization.

  • show_aside_menu_article_iconsboolean必須

    Advanced customization.

  • show_aside_menu_collection_iconsboolean必須

    Advanced customization.

  • footer_layoutstring必須

    Advanced customization.

  • footer_shape_typestring | null必須

    Advanced customization.

  • footer_linksobject[]必須

    Advanced customization.

    • titlestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • footer_link_translationsobject[]必須

    Advanced customization.

    • localestring | null
    • groupsobject[]
      • titlestring | null
      • linksobject[]
        • titlestring | null
        • urlstring | null
  • footer_text_translationsobject[]必須

    Advanced customization.

    • localestring | null
    • valuestring | null
  • social_media_linksobject[]必須

    Advanced customization.

    • titlestring | null
    • urlstring | null
  • social_link_translationsobject[]必須

    Advanced customization.

    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • show_contact_us_buttonboolean必須

    Advanced customization. While it is true, every update turns the site's contact form on.

  • contact_us_custom_linkstring | null必須

    Advanced customization.

  • contact_us_button_positionstring | null必須

    Advanced customization.

  • show_powered_by_badgeboolean必須

    Remove branding.

  • themestring | null必須

    The code of a theme from List themes. null leaves the theme unchanged. Advanced customization.