Získat černou listinu

GET/api/crm/v2/black_listv2

operationId: blackList.default

Autorizace

api-token + language + role

Parametry dotazu

page_numberinteger

Příklad: 1

phone_format_idinteger

Příklad: 1

phone_numberstring

Příklad: (707) 712-51-19

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

phone_format_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

phone_numberobject (FilterInput)

valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

idobject (FilterId)

valueany

Příklad: 0

typestringpovinné

Příklad: integer

placeholderstring

Příklad: integer

modestring (FilterMode)

Hodnoty:force_shownvalue_required

Příklad: value_required

listarray of object

idintegerpovinné

Příklad: 82348

datestring (DataTimeFormat) povinné

Příklad: 17:45 06/05/2024

chain_idintegerpovinné

Příklad: 7143

client_account_idinteger

Příklad: 0

client_branch_profile_idinteger

Příklad: 0

phone_format_idinteger

Příklad: 4

phone_numberstring

Příklad: 7077125119

blockedbooleanpovinné

Příklad: true

client_namestring

Příklad: example

paginationobject (Pagination)

max_countintegerpovinné

Počet položek na stránku

Příklad: 30

page_numberintegerpovinné

Číslo aktuální stránky; omezeno tak, aby posun nepřesáhl 1000

Příklad: 1

has_nextbooleanpovinné

Zda existuje další stránka

Příklad: true

has_previousbooleanpovinné

Zda existuje předchozí stránka

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } } }