Получить чёрный список

GET/api/crm/v2/black_listv2

operationId: blackList.default

Авторизация

api-token + language + role

Параметры запроса

page_numberinteger

Пример: 1

phone_format_idinteger

Пример: 1

phone_numberstring

Пример: (707) 712-51-19

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

filtersobject

phone_format_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

typestringобязательный

Пример: select

optionarray of object

valueintegerобязательный

Пример: 8920

namestringобязательный

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

phone_numberobject (FilterInput)

valuestring

Пример: example

typestringобязательный

Пример: integer or string

placeholderstring

Пример: string

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

idobject (FilterId)

valueany

Пример: 0

typestringобязательный

Пример: integer

placeholderstring

Пример: integer

modestring (FilterMode)

Значения:force_shownvalue_required

Пример: value_required

listarray of object

idintegerобязательный

Пример: 82348

datestring (DataTimeFormat) обязательный

Пример: 17:45 06/05/2024

chain_idintegerобязательный

Пример: 7143

client_account_idinteger

Пример: 0

client_branch_profile_idinteger

Пример: 0

phone_format_idinteger

Пример: 4

phone_numberstring

Пример: 7077125119

blockedbooleanобязательный

Пример: true

client_namestring

Пример: example

paginationobject (Pagination)

max_countintegerобязательный

Количество элементов на странице

Пример: 30

page_numberintegerобязательный

Номер текущей страницы; ограничен так, чтобы смещение не превышало 1000

Пример: 1

has_nextbooleanобязательный

Есть ли следующая страница

Пример: true

has_previousbooleanобязательный

Есть ли предыдущая страница

Пример: false

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/black_list", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/black_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "phone_format_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "phone_number": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "id": { "value": 0, "type": "integer", "placeholder": "integer", "mode": "value_required" } }, "list": [ { "id": 82348, "date": "17:45 06/05/2024", "chain_id": 7143, "client_account_id": 0, "client_branch_profile_id": 0, "phone_format_id": 4, "phone_number": "7077125119", "blocked": true, "client_name": "example" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }