API

İstifadəçilərin siyahısını və ya bir istifadəçini əldə et

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

id olmadan, istifadəçilərin qısa məlumatları ilə səhifələnmiş siyahısı qaytarılır. id ilə isə, tam istifadəçi məlumatı data.list[0] daxilində, səhifələmə və filtrlər olmadan qaytarılır. Rejim (partner və ya affiliate) server tərəfindən sessiyaya əsasən təyin olunur. Rol üzrə filtr (permission_role_id) və ada görə axtarış (name) məcburi deyil.

Avtorizasiya

api-token + language + role

Sorğu parametrləri

idinteger

Əgər ötürülərsə, yalnız bir tam qeyd səhifələşdirmə olmadan qaytarılır

Nümunə: 1

permission_role_idinteger

Nümunə: 1

namestring

Bütün rejimlər; istifadəçi adının alt sətri (ad və soyad) böyük-kiçik hərfə həssas olmadan

Nümunə: Alina

page_numberinteger

Nümunə: 1

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Nümunə: example

typestringmütləq

Nümunə: select

optionarray of object
valuestringmütləq

Nümunə: example

namestringmütləq

Nümunə: All

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

account_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object
valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

nameobject (FilterInput)
valuestring

Nümunə: example

typestringmütləq

Nümunə: integer or string

placeholderstring

Nümunə: string

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

listarray of oneOf
oneOf
Variantlardan biri
object (PermissionRoleUserPartner)

İstifadəçi partner rejimində

idintegermütləq

Nümunə: 1

namestring

Nümunə: John Doe

emailstring

Nümunə: user@example.com

photostring

Nümunə: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectmütləq

İstifadəçinin bütün rolları, rolun id-nə görə sıralanıb

idintegermütləq

Nümunə: 5

namestringmütləq

Rol adının referans kitabçasından adı; dəyərlər dəsti açıqdır

Nümunə: head_of_sales

blockedbooleanmütləq

Bloklama açarının vəziyyəti

Nümunə: false

phone_format_idinteger (PhoneFormatId)

Ölkə kodu: 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ümunə: 1

phone_numberstring

Nümunə: 9999999999

date_creationstring (DataTimeFormatSQL)

Nümunə: 2024-05-02 08:31:16

bound_settingsarray of string

İstifadəçi ilə əlaqəli silinmə zamanı xəbərdarlıq üçün ayarlar; yoxdursa, null

can_toggle_blockbooleanmütləq

Bloklama keçidi bu sətrdə cari istifadəçi üçün əlçatandır; qaydanı server müəyyən edir, rolların adlarından çıxarmayın

Nümunə: true

can_manage_sessionsbooleanmütləq

Cari istifadəçi bu sətrin sessiyalarını baxa və bağlaya bilər

Nümunə: false

paginationobject (Pagination)
max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false