API

Get base settings

GET/api/crm/v2/base_settingsv2
operationId: baseSettings.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

default_imagestring

Example: https://cdn.foodsoul.test/zones/ru/chains/7160/images/main/79dc3bfc72d9cb6176a13a5e9a17d0aa.png?v1745397512

general_settingsobject
aboutstring

HTML text

Example: <b>About branch</b>

noticestring

Example: welcome

blockbooleanrequired

Example: true

cart_lead_timebooleanrequired

Example: true

cart_noticestring

Example: free delivery

order_message_minutesintegerrequired

Example: 10

order_message_permanent_clientbooleanrequired

Example: true

order_message_prepayment_orderbooleanrequired

Example: true

order_message_custom_texts_prepayment_and_not_workstring

Example: text

order_message_custom_texts_prepayment_and_workstring

Example: text

order_message_custom_texts_workstring

Example: text

order_message_custom_texts_not_workstring

Example: text

social_network_vkstring

Example: https://vk.com/id1

social_network_okstring

Example: https://ok.ru/username

social_network_tgstring

Example: https://t.me/@username

social_network_wastring

Example: https://chat.whatsapp.com/@username

social_network_fbstring

Example: https://facebook.com/username

social_network_instring

Example: https://instagram.com/username

fieldsobject
senderarray of objectrequired
namestringrequired

Example: greeting_card

requiredbooleanrequired

Example: false

enabledbooleanrequired

Example: true

changeablebooleanrequired

Show the required toggle; displayed if the value is not bool

Example: true

typestringrequired

Set by the system; the branch cannot modify it

Values:integerstringphoneemailbool

Example: string

lengthinteger

Maximum value length. Set by the system; a branch can change it only for fields with extendable.

Example: 200

extendableboolean

Does length apply to the field?

Example: true

recipientarray of objectrequired
namestringrequired

Example: greeting_card

requiredbooleanrequired

Example: false

enabledbooleanrequired

Example: true

changeablebooleanrequired

Show the required toggle; displayed if the value is not bool

Example: true

typestringrequired

Set by the system; the branch cannot modify it

Values:integerstringphoneemailbool

Example: string

lengthinteger

Maximum value length. Set by the system; a branch can change it only for fields with extendable.

Example: 200

extendableboolean

Does length apply to the field?

Example: true

addressarray of objectrequired
namestringrequired

Example: greeting_card

requiredbooleanrequired

Example: false

enabledbooleanrequired

Example: true

changeablebooleanrequired

Show the required toggle; displayed if the value is not bool

Example: true

typestringrequired

Set by the system; the branch cannot modify it

Values:integerstringphoneemailbool

Example: string

lengthinteger

Maximum value length. Set by the system; a branch can change it only for fields with extendable.

Example: 200

extendableboolean

Does length apply to the field?

Example: true

additionalarray of objectrequired
namestringrequired

Example: greeting_card

requiredbooleanrequired

Example: false

enabledbooleanrequired

Example: true

changeablebooleanrequired

Show the required toggle; displayed if the value is not bool

Example: true

typestringrequired

Set by the system; the branch cannot modify it

Values:integerstringphoneemailbool

Example: string

lengthinteger

Maximum value length. Set by the system; a branch can change it only for fields with extendable.

Example: 200

extendableboolean

Does length apply to the field?

Example: true