Get blacklist

GET/api/crm/v2/black_listv2

operationId: blackList.default

Authorization

api-token + language + role

Query parameters

page_numberinteger

Example: 1

phone_format_idinteger

Example: 1

phone_numberstring

Example: (707) 712-51-19

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

phone_format_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

phone_numberobject (FilterInput)

valuestring

Example: example

typestringrequired

Example: integer or string

placeholderstring

Example: string

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

idobject (FilterId)

valueany

Example: 0

typestringrequired

Example: integer

placeholderstring

Example: integer

modestring (FilterMode)

Values:force_shownvalue_required

Example: value_required

listarray of object

idintegerrequired

Example: 82348

datestring (DataTimeFormat) required

Example: 17:45 06/05/2024

chain_idintegerrequired

Example: 7143

client_account_idinteger

Example: 0

client_branch_profile_idinteger

Example: 0

phone_format_idinteger

Example: 4

phone_numberstring

Example: 7077125119

blockedbooleanrequired

Example: true

client_namestring

Example: example

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

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/black_list', [ '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/black_list", { 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/black_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "en", "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 } } }