Get a list of branches

GET/api/crm/v2/branchesv2

operationId: branches.default

Authorization

api-token + language + role

Query parameters

page_numberinteger

Example: 1

chain_idinteger

branch_idinteger

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

One of the options

object

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

listarray of object

idintegerrequired

Example: 1

datestring (DataTimeFormatSQL) required

Example: 2024-05-02 08:31:16

branch_namestring

Example: Don't touch

chain_idintegerrequired

Example: 1

publishedbooleanrequired

Example: true

branch_balancenumberrequired

Example: 1000

feedback_enabledbooleanrequired

Example: true

email_for_feedbackstring

Example: example@example.com

preorder_in_work_timeboolean

Example: true

preorder_enableboolean

Example: true

preorder_alwaysboolean

Example: true

preorder_delivery_minimum_minutesinteger

Example: 0

preorder_delivery_maximum_daysinteger

Example: 3

preorder_pickup_minimum_minutesinteger

Example: 10

preorder_pickup_maximum_daysinteger

Example: 1

order_auto_confirm_enabledboolean

Example: true

order_auto_confirm_delay_minutes_weekdaysinteger

Example: 30

order_auto_confirm_delay_minutes_weekendinteger

Example: 60

order_auto_confirm_delay_minutes_holidaysinteger

Example: 90

order_countdown_enabledboolean

Example: true

phone_mask_enableboolean

Example: true

phone_formatboolean

Example: true

phone_internationalboolean

Example: true

email_format_addressboolean

Example: true

email_lite_versionboolean

Example: true

email_include_photoboolean

Example: true

email_permanent_clientboolean

Example: true

invoice_splittedboolean

Example: true

chain_namestringrequired

Example: Green Basket

repeat_order_notification_enabledbooleanrequired

Example: true

show_category_enabledbooleanrequired

Example: true

city_idintegerrequired

Example: 739

round_costs_modestringrequired

Values:half_uphalf_downhalf_evenceilingfloor

Example: half_even

round_costs_to_precisionintegerrequired

Example: 2

account_idintegerrequired

Example: 1

account_balancenumberrequired

Example: 0.01

blocking_statusstringrequired

Values:activatedblockedfrozen

Example: activated

city_namestringrequired

Example: London

tokenstringrequired

Example: f86e6fbdb2db6f1f97b99650e19669eb

paginationobject (Pagination)

max_countintegerrequired

Number of items per page

Example: 30

page_numberintegerrequired

Current page number; limited so that the offset does not exceed 1000

Example: 1

has_nextbooleanrequired

Is there a next page

Example: true

has_previousbooleanrequired

Is there a previous page

Example: false

tg_bot_namestring

Example: fs_feedback_notifications_bot

max_bot_namestring

Example: fs_feedback_notifications_bot

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/branches', [ '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/branches", { 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/branches", 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": [ {} ], "mode": "value_required" } }, "list": [ { "id": 1, "date": "2024-05-02 08:31:16", "branch_name": "Don't touch", "chain_id": 1, "published": true, "branch_balance": 1000, "feedback_enabled": true, "email_for_feedback": "example@example.com", "preorder_in_work_time": true, "preorder_enable": true, "preorder_always": true, "preorder_delivery_minimum_minutes": 0, "preorder_delivery_maximum_days": 3, "preorder_pickup_minimum_minutes": 10, "preorder_pickup_maximum_days": 1, "order_auto_confirm_enabled": true, "order_auto_confirm_delay_minutes_weekdays": 30, "order_auto_confirm_delay_minutes_weekend": 60, "order_auto_confirm_delay_minutes_holidays": 90, "order_countdown_enabled": true, "phone_mask_enable": true, "phone_format": true, "phone_international": true, "email_format_address": true, "email_lite_version": true, "email_include_photo": true, "email_permanent_client": true, "invoice_splitted": true, "chain_name": "Green Basket", "repeat_order_notification_enabled": true, "show_category_enabled": true, "city_id": 739, "round_costs_mode": "half_even", "round_costs_to_precision": 2, "account_id": 1, "account_balance": 0.01, "blocking_status": "activated", "city_name": "London", "token": "f86e6fbdb2db6f1f97b99650e19669eb" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "tg_bot_name": "fs_feedback_notifications_bot", "max_bot_name": "fs_feedback_notifications_bot" } }