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

Autorizações

  • Authorizationstringheader

    api_key · http · bearer

    read
  • Authorizationstringheader

    oauth · oauth2

    read

Parâmetros de caminho

  • site_idstringobrigatório

    The id of a site from List sites.

Cabeçalhos

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

Respostas

The site's branding.

Cabeçalhos

  • 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 | nullobrigatório

    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 | nullobrigatório

    The colour mode readers get. null leaves it unchanged.

    • defaultstring | null
    • strictboolean
  • layout_collectionstringobrigatório
  • layout_articlestringobrigatório
  • primary_fontstring | nullobrigatório
  • secondary_fontstring | nullobrigatório
  • header_variantstring | nullobrigatório
  • headline_sizestring | nullobrigatório
  • header_background_typestring | nullobrigatório
  • header_gradient_typestring | nullobrigatório
  • header_gradient_angleinteger | nullobrigatório
  • header_gradient_colorsobject[]obrigatório
    • colorstring

      A #rrggbb hexadecimal colour.

    • positioninteger | null
  • header_shape_typestring | nullobrigatório

    Advanced customization.

  • header_linksobject[]obrigatório
    • titlestring | null
    • urlstring | null
  • header_link_translationsobject[]obrigatório
    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • homepage_linkstring | nullobrigatório
  • homepage_link_translationsobject[]obrigatório
    • localestring | null
    • valuestring | null
  • search_bar_lengthstringobrigatório
  • search_bar_alignmentstringobrigatório
  • search_bar_corner_stylestringobrigatório
  • search_bar_shadowstring | nullobrigatório
  • search_result_variantstring | nullobrigatório
  • instant_searchbooleanobrigatório

    Advanced customization.

  • segmented_search_resultsbooleanobrigatório

    Advanced customization.

  • ai_search_enabledbooleanobrigatório
  • ai_search_display_modestring | nullobrigatório

    Advanced customization.

  • ai_search_aside_positionstring | nullobrigatório

    Advanced customization.

  • collections_stylestringobrigatório
  • collection_card_corner_stylestringobrigatório
  • collection_section_variantstring | nullobrigatório
  • collection_content_variantstring | nullobrigatório
  • collapsable_sub_categoriesbooleanobrigatório
  • collapsable_sub_categories_default_statestringobrigatório
  • show_collection_iconsbooleanobrigatório
  • show_collection_descriptionsbooleanobrigatório
  • show_collection_contentbooleanobrigatório
  • show_collection_authorsbooleanobrigatório
  • show_collection_articles_countbooleanobrigatório
  • articles_stylestringobrigatório
  • article_card_corner_stylestringobrigatório
  • content_tabs_stylestring | nullobrigatório

    null leaves it unchanged.

  • article_footer_variantstring | nullobrigatório
  • table_of_contents_positionstringobrigatório
  • show_table_of_contentsbooleanobrigatório
  • show_article_iconsbooleanobrigatório
  • show_article_descriptionsbooleanobrigatório
  • show_article_authorsbooleanobrigatório
  • show_related_articlesbooleanobrigatório
  • show_breadcrumb_iconboolean | nullobrigatório

    null for a site that never set it.

  • show_article_publish_datebooleanobrigatório

    Advanced customization.

  • show_article_page_authorbooleanobrigatório

    Advanced customization.

  • show_article_feedback_formboolean | nullobrigatório

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

  • require_email_for_article_feedbackboolean | nullobrigatório

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

  • feedback_reaction_stylestring | nullobrigatório

    Advanced customization.

  • feedback_question_labelstring | nullobrigatório

    Advanced customization.

  • feedback_comment_modestring | nullobrigatório

    Advanced customization.

  • aside_menu_expansion_modestring | nullobrigatório

    Advanced customization.

  • show_aside_menu_article_iconsbooleanobrigatório

    Advanced customization.

  • show_aside_menu_collection_iconsbooleanobrigatório

    Advanced customization.

  • footer_layoutstringobrigatório

    Advanced customization.

  • footer_shape_typestring | nullobrigatório

    Advanced customization.

  • footer_linksobject[]obrigatório

    Advanced customization.

    • titlestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • footer_link_translationsobject[]obrigatório

    Advanced customization.

    • localestring | null
    • groupsobject[]
      • titlestring | null
      • linksobject[]
        • titlestring | null
        • urlstring | null
  • footer_text_translationsobject[]obrigatório

    Advanced customization.

    • localestring | null
    • valuestring | null
  • social_media_linksobject[]obrigatório

    Advanced customization.

    • titlestring | null
    • urlstring | null
  • social_link_translationsobject[]obrigatório

    Advanced customization.

    • localestring | null
    • linksobject[]
      • titlestring | null
      • urlstring | null
  • show_contact_us_buttonbooleanobrigatório

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

  • contact_us_custom_linkstring | nullobrigatório

    Advanced customization.

  • contact_us_button_positionstring | nullobrigatório

    Advanced customization.

  • show_powered_by_badgebooleanobrigatório

    Remove branding.

  • themestring | nullobrigatório

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