Get site settings

GET/api/crm/v2/sites_settingsv2

operationId: sitesSettings.default

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 8810

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobjectrequired

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

noticestring

Example: message

yandex_metrikastring

Example: 314159

listarray of object

idstringrequired

Composite identifier: [page]_[platform]_[type]_[section]

Example: all_site_desktop_head

pagestringrequired

Values:allaboutfeedbackmainmobidel-trackerpopularrecommendspecial-offersvacancies

Example: all

platformstringrequired

Values:allsitesocial-app

Example: all

typestringrequired

Values:alldesktopmobile

Example: all

sectionstringrequired

Values:headbody

Example: head

htmlstringrequired

Example: <meta name='robots' content='index, follow'>

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'en', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/sites_settings?branch_id=8810", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "notice": "message", "yandex_metrika": "314159", "list": [ { "id": "all_site_desktop_head", "page": "all", "platform": "all", "type": "all", "section": "head", "html": "<meta name='robots' content='index, follow'>" } ] } }