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

Autorizzazioni

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Parametri di percorso

  • site_idstringobbligatorio

    The id of a site from List sites.

Intestazioni

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

Risposte

The site's branding.

Intestazioni

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

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

    The colour mode readers get. null leaves it unchanged.

    • defaultstring | null
    • strictboolean
  • layout_collectionstringobbligatorio
  • layout_articlestringobbligatorio
  • primary_fontstring | nullobbligatorio
  • secondary_fontstring | nullobbligatorio
  • header_variantstring | nullobbligatorio
  • headline_sizestring | nullobbligatorio
  • header_background_typestring | nullobbligatorio
  • header_gradient_typestring | nullobbligatorio
  • header_gradient_angleinteger | nullobbligatorio
  • header_gradient_colorsobject[]obbligatorio
    • colorstring

      A #rrggbb hexadecimal colour.

    • positioninteger | null
  • header_shape_typestring | nullobbligatorio

    Advanced customization.

  • header_linksobject[]obbligatorio
    • titlestring | null
    • urlstring | null
  • header_link_translationsobject[]obbligatorio
    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • homepage_linkstring | nullobbligatorio
  • homepage_link_translationsobject[]obbligatorio
    • localestring | null
    • valuestring | null
  • search_bar_lengthstringobbligatorio
  • search_bar_alignmentstringobbligatorio
  • search_bar_corner_stylestringobbligatorio
  • search_bar_shadowstring | nullobbligatorio
  • search_result_variantstring | nullobbligatorio
  • instant_searchbooleanobbligatorio

    Advanced customization.

  • segmented_search_resultsbooleanobbligatorio

    Advanced customization.

  • ai_search_enabledbooleanobbligatorio
  • ai_search_display_modestring | nullobbligatorio

    Advanced customization.

  • ai_search_aside_positionstring | nullobbligatorio

    Advanced customization.

  • collections_stylestringobbligatorio
  • collection_card_corner_stylestringobbligatorio
  • collection_section_variantstring | nullobbligatorio
  • collection_content_variantstring | nullobbligatorio
  • collapsable_sub_categoriesbooleanobbligatorio
  • collapsable_sub_categories_default_statestringobbligatorio
  • show_collection_iconsbooleanobbligatorio
  • show_collection_descriptionsbooleanobbligatorio
  • show_collection_contentbooleanobbligatorio
  • show_collection_authorsbooleanobbligatorio
  • show_collection_articles_countbooleanobbligatorio
  • articles_stylestringobbligatorio
  • article_card_corner_stylestringobbligatorio
  • content_tabs_stylestring | nullobbligatorio

    null leaves it unchanged.

  • article_footer_variantstring | nullobbligatorio
  • table_of_contents_positionstringobbligatorio
  • show_table_of_contentsbooleanobbligatorio
  • show_article_iconsbooleanobbligatorio
  • show_article_descriptionsbooleanobbligatorio
  • show_article_authorsbooleanobbligatorio
  • show_related_articlesbooleanobbligatorio
  • show_breadcrumb_iconboolean | nullobbligatorio

    null for a site that never set it.

  • show_article_publish_datebooleanobbligatorio

    Advanced customization.

  • show_article_page_authorbooleanobbligatorio

    Advanced customization.

  • show_article_feedback_formboolean | nullobbligatorio

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

  • require_email_for_article_feedbackboolean | nullobbligatorio

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

  • feedback_reaction_stylestring | nullobbligatorio

    Advanced customization.

  • feedback_question_labelstring | nullobbligatorio

    Advanced customization.

  • feedback_comment_modestring | nullobbligatorio

    Advanced customization.

  • aside_menu_expansion_modestring | nullobbligatorio

    Advanced customization.

  • show_aside_menu_article_iconsbooleanobbligatorio

    Advanced customization.

  • show_aside_menu_collection_iconsbooleanobbligatorio

    Advanced customization.

  • footer_layoutstringobbligatorio

    Advanced customization.

  • footer_shape_typestring | nullobbligatorio

    Advanced customization.

  • footer_linksobject[]obbligatorio

    Advanced customization.

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

    Advanced customization.

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

    Advanced customization.

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

    Advanced customization.

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

    Advanced customization.

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

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

  • contact_us_custom_linkstring | nullobbligatorio

    Advanced customization.

  • contact_us_button_positionstring | nullobbligatorio

    Advanced customization.

  • show_powered_by_badgebooleanobbligatorio

    Remove branding.

  • themestring | nullobbligatorio

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