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>'

Authorizations

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Path parameters

  • site_idstringrequired

    The id of a site from List sites.

Headers

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

Responses

The site's branding.

Headers

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

    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 | nullrequired

    The colour mode readers get. null leaves it unchanged.

    • defaultstring | null
    • strictboolean
  • layout_collectionstringrequired
  • layout_articlestringrequired
  • primary_fontstring | nullrequired
  • secondary_fontstring | nullrequired
  • header_variantstring | nullrequired
  • headline_sizestring | nullrequired
  • header_background_typestring | nullrequired
  • header_gradient_typestring | nullrequired
  • header_gradient_angleinteger | nullrequired
  • header_gradient_colorsobject[]required
    • colorstring

      A #rrggbb hexadecimal colour.

    • positioninteger | null
  • header_shape_typestring | nullrequired

    Advanced customization.

  • header_linksobject[]required
    • titlestring | null
    • urlstring | null
  • header_link_translationsobject[]required
    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • homepage_linkstring | nullrequired
  • homepage_link_translationsobject[]required
    • localestring | null
    • valuestring | null
  • search_bar_lengthstringrequired
  • search_bar_alignmentstringrequired
  • search_bar_corner_stylestringrequired
  • search_bar_shadowstring | nullrequired
  • search_result_variantstring | nullrequired
  • instant_searchbooleanrequired

    Advanced customization.

  • segmented_search_resultsbooleanrequired

    Advanced customization.

  • ai_search_enabledbooleanrequired
  • ai_search_display_modestring | nullrequired

    Advanced customization.

  • ai_search_aside_positionstring | nullrequired

    Advanced customization.

  • collections_stylestringrequired
  • collection_card_corner_stylestringrequired
  • collection_section_variantstring | nullrequired
  • collection_content_variantstring | nullrequired
  • collapsable_sub_categoriesbooleanrequired
  • collapsable_sub_categories_default_statestringrequired
  • show_collection_iconsbooleanrequired
  • show_collection_descriptionsbooleanrequired
  • show_collection_contentbooleanrequired
  • show_collection_authorsbooleanrequired
  • show_collection_articles_countbooleanrequired
  • articles_stylestringrequired
  • article_card_corner_stylestringrequired
  • content_tabs_stylestring | nullrequired

    null leaves it unchanged.

  • article_footer_variantstring | nullrequired
  • table_of_contents_positionstringrequired
  • show_table_of_contentsbooleanrequired
  • show_article_iconsbooleanrequired
  • show_article_descriptionsbooleanrequired
  • show_article_authorsbooleanrequired
  • show_related_articlesbooleanrequired
  • show_breadcrumb_iconboolean | nullrequired

    null for a site that never set it.

  • show_article_publish_datebooleanrequired

    Advanced customization.

  • show_article_page_authorbooleanrequired

    Advanced customization.

  • show_article_feedback_formboolean | nullrequired

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

  • require_email_for_article_feedbackboolean | nullrequired

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

  • feedback_reaction_stylestring | nullrequired

    Advanced customization.

  • feedback_question_labelstring | nullrequired

    Advanced customization.

  • feedback_comment_modestring | nullrequired

    Advanced customization.

  • aside_menu_expansion_modestring | nullrequired

    Advanced customization.

  • show_aside_menu_article_iconsbooleanrequired

    Advanced customization.

  • show_aside_menu_collection_iconsbooleanrequired

    Advanced customization.

  • footer_layoutstringrequired

    Advanced customization.

  • footer_shape_typestring | nullrequired

    Advanced customization.

  • footer_linksobject[]required

    Advanced customization.

    • titlestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • footer_link_translationsobject[]required

    Advanced customization.

    • localestring | null
    • groupsobject[]
      • titlestring | null
      • linksobject[]
        • titlestring | null
        • urlstring | null
  • footer_text_translationsobject[]required

    Advanced customization.

    • localestring | null
    • valuestring | null
  • social_media_linksobject[]required

    Advanced customization.

    • titlestring | null
    • urlstring | null
  • social_link_translationsobject[]required

    Advanced customization.

    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • show_contact_us_buttonbooleanrequired

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

  • contact_us_custom_linkstring | nullrequired

    Advanced customization.

  • contact_us_button_positionstring | nullrequired

    Advanced customization.

  • show_powered_by_badgebooleanrequired

    Remove branding.

  • themestring | nullrequired

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