API

Hangi kasutajate loendi või ühe kasutaja

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

Ilma id-ta tagastab lehekülgede kaupa kasutajate nimekirja lühendatud kirjetega. Kui on määratud id, tagastatakse täielik kasutaja kirje data.list[0], ilma lehekülgede ja filtriteta. Režiimi (partner või affiliate) määrab server seansi põhjal. Rolli filter (permission_role_id) ja nimeotsing (name) on valikulised.

Autoriseerimine

api-token + language + role

Päringu parameetrid

idinteger

Kui on edastatud, tagastatakse üks täielik kirje ilma lehekülgedeta

Näide: 1

permission_role_idinteger

Näide: 1

namestring

Kõik režiimid; kasutajanime alamstring (ees- ja perekonnanimi), tõstutundetu

Näide: Alina

page_numberinteger

Näide: 1

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Näide: example

typestringkohustuslik

Näide: select

optionarray of object
valuestringkohustuslik

Näide: example

namestringkohustuslik

Näide: All

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

account_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

nameobject (FilterInput)
valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

listarray of oneOf
oneOf
Üks variantidest
object (PermissionRoleUserPartner)

Kasutaja režiimis partner

idintegerkohustuslik

Näide: 1

namestring

Näide: John Doe

emailstring

Näide: user@example.com

photostring

Näide: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectkohustuslik

Kõik kasutaja rollid, järjestatud rolli id järgi

idintegerkohustuslik

Näide: 5

namestringkohustuslik

Rolli nimi rollide kataloogist; väärtuste komplekt on avatud

Näide: head_of_sales

blockedbooleankohustuslik

Blokeeringulüliti olek

Näide: false

phone_format_idinteger (PhoneFormatId)

Riigikood: 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)

Näide: 1

phone_numberstring

Näide: 9999999999

date_creationstring (DataTimeFormatSQL)

Näide: 2024-05-02 08:31:16

bound_settingsarray of string

Kasutajaga seotud seaded kustutamise hoiatamiseks; null, kui puuduvad

can_toggle_blockbooleankohustuslik

Blokeeringu lüliti on selles reas praegusele kasutajale saadaval; reegli määrab server, ärge järeldage seda rollinimedest

Näide: true

can_manage_sessionsbooleankohustuslik

Käesolev kasutaja saab vaadata ja sulgeda selle rea seansse

Näide: false

paginationobject (Pagination)
max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false