API

Získat seznam uživatelů nebo jednoho uživatele

GET/api/crm/v2/teamv2
operationId: team.default

Bez id vrací stránkovaný seznam uživatelů se zkrácenými záznamy. S id je v data.list[0] vrácen kompletní záznam uživatele, bez stránkování a filtrů. Režim (partner nebo affiliate) určuje server podle relace. Filtrování podle role (permission_role_id) a vyhledávání podle jména (name) jsou volitelné.

Autorizace

api-token + language + role

Parametry dotazu

idinteger

Pokud je předán, vrací se jeden úplný záznam bez stránkování

Příklad: 1

permission_role_idinteger

Příklad: 1

namestring

Všechny režimy; podřetězec uživatelského jména (jméno a příjmení) bez rozlišení velikosti písmen

Příklad: Alina

page_numberinteger

Příklad: 1

Odpovědi

OK

object
statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of object
valuestringpovinné

Příklad: example

namestringpovinné

Příklad: All

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

account_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

affiliate_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

permission_role_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

nameobject (FilterInput)
valuestring

Příklad: example

typestringpovinné

Příklad: integer or string

placeholderstring

Příklad: string

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

listarray of oneOf
oneOf
Jedna z možností
object (PermissionRoleUserPartner)

Uživatel v režimu partner

idintegerpovinné

Příklad: 1

namestring

Příklad: John Doe

emailstring

Příklad: user@example.com

photostring

Příklad: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectpovinné

Všechny role uživatele, seřazené podle id role

idintegerpovinné

Příklad: 5

namestringpovinné

Název role ze seznamu rolí; sada hodnot je otevřená

Příklad: head_of_sales

blockedbooleanpovinné

Stav přepínače blokování

Příklad: false

phone_format_idinteger (PhoneFormatId)

Kód země: 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)

Příklad: 1

phone_numberstring

Příklad: 9999999999

date_creationstring (DataTimeFormatSQL)

Příklad: 2024-05-02 08:31:16

bound_settingsarray of string

Nastavení související s uživatelem pro varování při mazání; null, pokud neexistují

can_toggle_blockbooleanpovinné

Přepínač blokování je v tomto řádku dostupný aktuálnímu uživateli; pravidlo určuje server, neodvozujte jej z názvů rolí

Příklad: true

can_manage_sessionsbooleanpovinné

Aktuální uživatel může zobrazit a ukončit relace tohoto řádku

Příklad: false

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