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

Ủy quyền

Authorizationstringheader
api_key · http · bearer
read
Authorizationstringheader
oauth · oauth2
read

Tham số đường dẫn

site_idstringbắt buộc
The id of a site from List sites.

Tiêu đề

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.

Phản hồi

The site's branding.

Tiêu đề

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 | nullbắt buộc
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 | nullbắt buộc
The colour mode readers get. null leaves it unchanged.
- defaultstring | null
- strictboolean
layout_collectionstringbắt buộc
layout_articlestringbắt buộc
primary_fontstring | nullbắt buộc
secondary_fontstring | nullbắt buộc
header_variantstring | nullbắt buộc
headline_sizestring | nullbắt buộc
header_background_typestring | nullbắt buộc
header_gradient_typestring | nullbắt buộc
header_gradient_angleinteger | nullbắt buộc
header_gradient_colorsobject[]bắt buộc
- colorstring
  A #rrggbb hexadecimal colour.
- positioninteger | null
header_shape_typestring | nullbắt buộc
Advanced customization.
header_linksobject[]bắt buộc
- titlestring | null
- urlstring | null
header_link_translationsobject[]bắt buộc
- localestring | null
- linksobject[]
  titlestring | null
  urlstring | null
homepage_linkstring | nullbắt buộc
homepage_link_translationsobject[]bắt buộc
- localestring | null
- valuestring | null
search_bar_lengthstringbắt buộc
search_bar_alignmentstringbắt buộc
search_bar_corner_stylestringbắt buộc
search_bar_shadowstring | nullbắt buộc
search_result_variantstring | nullbắt buộc
instant_searchbooleanbắt buộc
Advanced customization.
segmented_search_resultsbooleanbắt buộc
Advanced customization.
ai_search_enabledbooleanbắt buộc
ai_search_display_modestring | nullbắt buộc
Advanced customization.
ai_search_aside_positionstring | nullbắt buộc
Advanced customization.
collections_stylestringbắt buộc
collection_card_corner_stylestringbắt buộc
collection_section_variantstring | nullbắt buộc
collection_content_variantstring | nullbắt buộc
collapsable_sub_categoriesbooleanbắt buộc
collapsable_sub_categories_default_statestringbắt buộc
show_collection_iconsbooleanbắt buộc
show_collection_descriptionsbooleanbắt buộc
show_collection_contentbooleanbắt buộc
show_collection_authorsbooleanbắt buộc
show_collection_articles_countbooleanbắt buộc
articles_stylestringbắt buộc
article_card_corner_stylestringbắt buộc
content_tabs_stylestring | nullbắt buộc
null leaves it unchanged.
article_footer_variantstring | nullbắt buộc
table_of_contents_positionstringbắt buộc
show_table_of_contentsbooleanbắt buộc
show_article_iconsbooleanbắt buộc
show_article_descriptionsbooleanbắt buộc
show_article_authorsbooleanbắt buộc
show_related_articlesbooleanbắt buộc
show_breadcrumb_iconboolean | nullbắt buộc
null for a site that never set it.
show_article_publish_datebooleanbắt buộc
Advanced customization.
show_article_page_authorbooleanbắt buộc
Advanced customization.
show_article_feedback_formboolean | nullbắt buộc
Advanced customization. null for a site that never set it.
require_email_for_article_feedbackboolean | nullbắt buộc
Advanced customization. null for a site that never set it.
feedback_reaction_stylestring | nullbắt buộc
Advanced customization.
feedback_question_labelstring | nullbắt buộc
Advanced customization.
feedback_comment_modestring | nullbắt buộc
Advanced customization.
aside_menu_expansion_modestring | nullbắt buộc
Advanced customization.
show_aside_menu_article_iconsbooleanbắt buộc
Advanced customization.
show_aside_menu_collection_iconsbooleanbắt buộc
Advanced customization.
footer_layoutstringbắt buộc
Advanced customization.
footer_shape_typestring | nullbắt buộc
Advanced customization.
footer_linksobject[]bắt buộc
Advanced customization.
- titlestring | null
- linksobject[]
  titlestring | null
  urlstring | null
footer_link_translationsobject[]bắt buộc
Advanced customization.
- localestring | null
- groupsobject[]
  titlestring | null
  linksobject[]
  titlestring | null
  urlstring | null
footer_text_translationsobject[]bắt buộc
Advanced customization.
- localestring | null
- valuestring | null
social_media_linksobject[]bắt buộc
Advanced customization.
- titlestring | null
- urlstring | null
social_link_translationsobject[]bắt buộc
Advanced customization.
- localestring | null
- linksobject[]
  titlestring | null
  urlstring | null
show_contact_us_buttonbooleanbắt buộc
Advanced customization. While it is true, every update turns the site's contact form on.
contact_us_custom_linkstring | nullbắt buộc
Advanced customization.
contact_us_button_positionstring | nullbắt buộc
Advanced customization.
show_powered_by_badgebooleanbắt buộc
Remove branding.
themestring | nullbắt buộc
The code of a theme from List themes. null leaves the theme unchanged. Advanced customization.