API

Get mobile app settings

GET/api/crm/v2/mobile_apps_settingsv2
operationId: mobileAppsSettings.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

OK

object
statusstringrequired

Values:successerror

Example: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object
valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

check_access_for_force_update_iosboolean

Example: true

settingsobject
is_parent_chainbooleanrequired

Example: true

mobile_apps_titlestring

Example: Pizza

mobile_apps_subtitlestring

Example: Pizza

mobile_apps_icon_namestring

Example: icon1

mobile_apps_keywordsstring

Example: delivery,online,order,pizza,sushi,rolls,snacks,salads,sets

mobile_apps_short_descriptionstring

Example: We are here to make your day better

mobile_apps_full_descriptionstring

Example: Use the application to order food: pick your dishes, pay online and get them delivered to your door in a few clicks

update_metadataboolean

Example: true

update_screenshotsboolean

Example: true

ios_force_update_enabledboolean

Example: true

marketer_reviewedboolean

Example: true

auto_changebooleanrequired

Example: true

theme_defaultstring (ThemeDefault)

Possible values: light, bright, blue, dark

Values:lightbrightbluedark

Example: light

theme_daystring

Values:lightbright

Example: light

theme_nightstring

Values:bluedark

Example: dark

templatestring

Values:side_menubottom_menu

bottom_menu_icons_and_titles_boldboolean

Example: false

bottom_menu_titles_showboolean

Example: false

side_menu_icons_and_titles_boldboolean

Example: false

side_menu_background_colorstring

Example: E74C3C

side_menu_icons_and_titles_colorstring

Example: FFFFFF

main_colorstring

Example: 607D8B

catalog_items_image_ratiostring

Values:5:230:191:14:316:9

Example: 5:2

catalog_items_in_two_columnsboolean

Example: true

catalog_items_max_rows_descriptioninteger

Example: 99

catalog_horizontal_categoriesboolean

Example: false

catalog_items_animation_on_tap_enabledboolean

Example: false

special_offers_animation_on_tap_enabledboolean

Example: false

designer_reviewedboolean

Example: true

is_read_only_modebooleanrequired

Example: true

radius_blurinteger

Only if template = side_menu

Example: 0

background_imagestring

Example: https://cdn.foodsoul.test/backgrounds/mobile_apps/0f8bb6781f04a1cb0e231bd06356b86c.jpg

logostring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/themes/mobile_apps/87c8980728da83d80e4f8a5f7dfa67c4.png?v1748430033

google_play_metadatastring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/meta_data/google_play.png?v1748430936

ios_iconstring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/ios.png?v1748430936

watch_iconstring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/watch.png?v1748430936

android_iconstring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/icons/android.png?v1748430936

mobile_apps_title_status_of_checkstringrequired

Values:approvedtakenverification

Example: approved

apps_noticestring

Example: text

special_offers_separate_sectionboolean

Example: true

special_offers_title_in_catalogboolean

Example: true