API

Pobierz listę użytkowników lub pojedynczego użytkownika

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

Bez id zwraca stronicowaną listę użytkowników ze skróconymi rekordami. Z id w data.list[0] zwracany jest pełny rekord użytkownika, bez stronicowania i filtrów. Tryb (partner lub affiliate) ustalany jest przez serwer na podstawie sesji. Filtrowanie po roli (permission_role_id) i wyszukiwanie po nazwie (name) są opcjonalne.

Autoryzacja

api-token + language + role

Parametry zapytania

idinteger

Jeśli przekazano, zwracany jest jeden pełny rekord bez paginacji

Przykład: 1

permission_role_idinteger

Przykład: 1

namestring

Wszystkie tryby; podciąg nazwy użytkownika (imię i nazwisko) bez rozróżniania wielkości liter

Przykład: Alina

page_numberinteger

Przykład: 1

Odpowiedzi

OK

object
statusstringwymagane

Wartości:successerror

Przykład: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Przykład: example

typestringwymagane

Przykład: select

optionarray of object
valuestringwymagane

Przykład: example

namestringwymagane

Przykład: All

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

account_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object
valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

nameobject (FilterInput)
valuestring

Przykład: example

typestringwymagane

Przykład: integer or string

placeholderstring

Przykład: string

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

listarray of oneOf
oneOf
Jeden z wariantów
object (PermissionRoleUserPartner)

Użytkownik w trybie partner

idintegerwymagane

Przykład: 1

namestring

Przykład: John Doe

emailstring

Przykład: user@example.com

photostring

Przykład: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectwymagane

Wszystkie role użytkownika, uporządkowane według id roli

idintegerwymagane

Przykład: 5

namestringwymagane

Nazwa roli ze słownika ról; zestaw wartości jest otwarty

Przykład: head_of_sales

blockedbooleanwymagane

Stan przełącznika blokady

Przykład: false

phone_format_idinteger (PhoneFormatId)

Kod kraju: 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)

Przykład: 1

phone_numberstring

Przykład: 9999999999

date_creationstring (DataTimeFormatSQL)

Przykład: 2024-05-02 08:31:16

bound_settingsarray of string

Ustawienia powiązane z użytkownikiem do ostrzeżenia przy usuwaniu; null, jeśli brak

can_toggle_blockbooleanwymagane

Przełącznik blokady jest dostępny w tym wierszu dla bieżącego użytkownika; regułę określa serwer, nie wyprowadzaj jej z nazw ról

Przykład: true

can_manage_sessionsbooleanwymagane

Bieżący użytkownik może przeglądać i zamykać sesje tej pozycji

Przykład: false

paginationobject (Pagination)
max_countintegerwymagane

Liczba elementów na stronie

Przykład: 30

page_numberintegerwymagane

Numer bieżącej strony; ograniczony tak, aby przesunięcie nie przekraczało 1000

Przykład: 1

has_nextbooleanwymagane

Czy istnieje następna strona

Przykład: true

has_previousbooleanwymagane

Czy istnieje poprzednia strona

Przykład: false