Get integration settings with the automation system

GET/api/crm/v2/integration_automationsv2

operationId: integrationAutomations.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8922

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

settingsobject

chain_idintegerrequired

Example: 1

automation_idintegerrequired

Example: 1

automation_enabledbooleanrequired

Example: true

automation_error_notifications_enabledbooleanrequired

Example: true

price_smsstringrequired

Example: 3.5

tokenstringrequired

Example: f20138c54eaaad6c00ac77d27b2f4cb4

project_name_shortstringrequired

Example: FS

phone_clean_enabledbooleanrequired

Example: true

phone_plus_delete_enabledbooleanrequired

Example: true

phone_space_delete_enabledbooleanrequired

Example: true

qr_bar_code_enabledbooleanrequired

Example: true

callback_api_enabledbooleanrequired

Example: true

import_once_catalog_enabledbooleanrequired

Example: true

import_once_description_enabledbooleanrequired

Example: true

import_once_image_enabledbooleanrequired

Example: true

import_once_labels_enabledbooleanrequired

Example: true

districts_settingsarray of object

idintegerrequired

For default settings, id is 0

Example: 0

terminalstring

Form field key district_data_${district_id}_terminal

Example: terminal1

deliverystring

Form field key district_data_${district_id}_delivery

Example: delivery1

pickups_settingsarray of object

idintegerrequired

For default settings, id is 0

Example: 0

terminalstring

Form field key pickup_data_${pickup_id}_terminal

Example: terminal1

listarray of object

idintegerrequired

Example: 1

namestringrequired

Example: FrontPad

fieldsarray of object

encryptedbooleanrequired

Encrypted field; use a password-type input field for entry

Example: true

namestringrequired

Example: api_key

valueoneOf

One of the options

string

URL, имя файла или токен — для type=radio/select/file

Example: secret

typestring

Values:switchradiocheckboxselectfile

Example: switch

valuesarray of string

districtsbooleanrequired

Example: true

pickupsbooleanrequired

Example: true

sitestring

Example: https://frontpad.ru/

wikistring

Example: https://wiki.foodsoul.pro/i/40

import_modestringrequired

Values:nomanualautomatic

Example: no

webhook_link_enabledbooleanrequired

Example: true

webhook_setup_enabledbooleanrequired

Example: true

system_namestring

Example: front_pad

webhookstring

Example: https://ru.foodsoul.test/webhook/automation/front_pad/?token=f20138c54eaaad6c00ac77d27b2f4cb4

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/integration_automations", { 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.ru/api/crm/v2/integration_automations", 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" } }, "settings": { "chain_id": 1, "automation_id": 1, "automation_enabled": true, "automation_error_notifications_enabled": true, "price_sms": "3.5", "token": "f20138c54eaaad6c00ac77d27b2f4cb4", "project_name_short": "FS", "phone_clean_enabled": true, "phone_plus_delete_enabled": true, "phone_space_delete_enabled": true, "qr_bar_code_enabled": true, "callback_api_enabled": true, "import_once_catalog_enabled": true, "import_once_description_enabled": true, "import_once_image_enabled": true, "import_once_labels_enabled": true, "districts_settings": [ { "id": 0, "terminal": "terminal1", "delivery": "delivery1" } ], "pickups_settings": [ { "id": 0, "terminal": "terminal1" } ] }, "list": [ { "id": 1, "name": "FrontPad", "fields": [ { "encrypted": true, "name": "api_key", "type": "switch", "values": [] } ], "districts": true, "pickups": true, "site": "https://frontpad.ru/", "wiki": "https://wiki.foodsoul.pro/i/40", "import_mode": "no", "webhook_link_enabled": true, "webhook_setup_enabled": true, "system_name": "front_pad", "webhook": "https://ru.foodsoul.test/webhook/automation/front_pad/?token=f20138c54eaaad6c00ac77d27b2f4cb4" } ] } }