Get a list of operators

GET/api/crm/v2/operatorsv2

operationId: operators.default

Returns the operators of the selected branch (branch_id): contact phone, notification email, login (email of the linked user account), integration token, and order access level. Also returns the names of notification bots in Telegram and Max.

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8778

Responses

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

listarray of object

idintegerrequired

Example: 1

firm_user_idinteger

Example: 1

public_phonestring

Example: +79999999999

phone_format_idinteger (PhoneFormatId) required

Country code: 1-🇷🇺(+7|8), 2-🇦🇿(+994|0), 3-🇧🇾(+375|80), 4-🇰🇿(+7|8), 6-🇷🇸(+381|0), 7-🇹🇷(+90|0), 8-🇺🇦(+380|0), 9-🇵🇹(+351|0), 10-🇰🇬(+996|0), 11-🇺🇸(+1), 12-🇫🇷(+33|0), 13-🇲🇩(+373|0), 15-🇪🇪(+372), 18-🇬🇪(+995), 19-🇺🇿(+998), 22-🇵🇱(+48|0), 23-🇹🇯(+992|8), 25-🇷🇴(+40|0), 44-🇨🇭(+41|0)

Example: 1

phone_numberinteger

Example: 9999999999

phone_sms_enabledbooleanrequired

Example: false

email_for_notificationsarray of string

E-mail for notifications

loginstring

Example: operator@fs.pro

tokenstring

Example: f903b13687fc992414360dbc2050e250

permissionstringrequired

Order access: all — all orders, only — orders assigned to this operator

Values:allonly

Example: all

tg_bot_namestring

Example: fs_order_notifications_bot

max_bot_namestring

Example: fs_order_notifications_bot

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/operators', [ '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/operators", { 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/operators", 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" } }, "list": [ { "id": 1, "firm_user_id": 1, "public_phone": "+79999999999", "phone_format_id": 1, "phone_number": 9999999999, "phone_sms_enabled": false, "email_for_notifications": [ "operator@fs.pro" ], "login": "operator@fs.pro", "token": "f903b13687fc992414360dbc2050e250", "permission": "all" } ], "tg_bot_name": "fs_order_notifications_bot", "max_bot_name": "fs_order_notifications_bot" } }