API

Gauti vartotojų sąrašą arba vieną vartotoją

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

Be id grąžina puslapiuotą vartotojų sąrašą su sutrumpintomis eilutėmis. Su id į data.list[0] grąžinamas pilnas vartotojo įrašas, be puslapiavimo ir filtrų. Režimą (partner arba affiliate) nustato serveris pagal sesiją. Filtras pagal rolę (permission_role_id) ir paieška pagal vardą (name) yra neprivalomi.

Autorizacija

api-token + language + role

Užklausos parametrai

idinteger

Jei perduota, grąžinamas vienas pilnas įrašas be puslapiavimo

Pavyzdys: 1

permission_role_idinteger

Pavyzdys: 1

namestring

Visi režimai; naudotojo vardo (vardas ir pavardė) dalis, nepaisant raidžių dydžio

Pavyzdys: Alina

page_numberinteger

Pavyzdys: 1

Atsakymai

OK

object
statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: select

optionarray of object
valuestringprivalomas

Pavyzdys: example

namestringprivalomas

Pavyzdys: All

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

account_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object
valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

nameobject (FilterInput)
valuestring

Pavyzdys: example

typestringprivalomas

Pavyzdys: integer or string

placeholderstring

Pavyzdys: string

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

listarray of oneOf
oneOf
Vienas iš variantų
object (PermissionRoleUserPartner)

Vartotojas režime partner

idintegerprivalomas

Pavyzdys: 1

namestring

Pavyzdys: John Doe

emailstring

Pavyzdys: user@example.com

photostring

Pavyzdys: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectprivalomas

Visi naudotojo vaidmenys, surūšiuoti pagal vaidmens id

idintegerprivalomas

Pavyzdys: 5

namestringprivalomas

Rolės pavadinimas iš vaidmenų žinyno; reikšmių rinkinys atviras

Pavyzdys: head_of_sales

blockedbooleanprivalomas

Blokavimo perjungiklio būsena

Pavyzdys: false

phone_format_idinteger (PhoneFormatId)

Šalies kodas: 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)

Pavyzdys: 1

phone_numberstring

Pavyzdys: 9999999999

date_creationstring (DataTimeFormatSQL)

Pavyzdys: 2024-05-02 08:31:16

bound_settingsarray of string

Nustatymai, susiję su naudotoju, skirti įspėjimui šalinant; null, jei nėra

can_toggle_blockbooleanprivalomas

Blokavimo perjungiklis šioje eilutėje prieinamas dabartiniam naudotojui; taisyklę nustato serveris, neišveskite jos pagal vaidmenų pavadinimus

Pavyzdys: true

can_manage_sessionsbooleanprivalomas

Dabartinis naudotojas gali peržiūrėti ir uždaryti šios eilutės sesijas

Pavyzdys: false

paginationobject (Pagination)
max_countintegerprivalomas

Elementų skaičius puslapyje

Pavyzdys: 30

page_numberintegerprivalomas

Dabartinio puslapio numeris; apribotas taip, kad poslinkis neviršytų 1000

Pavyzdys: 1

has_nextbooleanprivalomas

Ar yra kitas puslapis

Pavyzdys: true

has_previousbooleanprivalomas

Ar yra ankstesnis puslapis

Pavyzdys: false