API

მომხმარებლების სიის ან ერთი მომხმარებლის მიღება

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

id-ის გარეშე აბრუნებს მომხმარებლების გვერდებად დაყოფილ სიას შემოკლებული ჩანაწერებით. id-ის მითითებისას data.list[0]-ში ბრუნდება მომხმარებლის სრული ჩანაწერი, გვერდების და ფილტრების გარეშე. რეჟიმს (partner ან affiliate) სერვერი ადგენს სესიის მიხედვით. როლის ფილტრი (permission_role_id) და სახელით ძიება (name) არ არის სავალდებულო.

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

idinteger

თუ გადაცემულია, ბრუნდება ერთი სრული ჩანაწერი გვერდების გარეშე

მაგალითი: 1

permission_role_idinteger

მაგალითი: 1

namestring

ყველა რეჟიმი; მომხმარებლის სახელის ქვე-სტრიქონი (სახელი და გვარი) რეგისტრის გაუთვალისწინებლად

მაგალითი: Alina

page_numberinteger

მაგალითი: 1

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: select

optionarray of object
valuestringსავალდებულო

მაგალითი: example

namestringსავალდებულო

მაგალითი: All

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

account_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

nameobject (FilterInput)
valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: integer or string

placeholderstring

მაგალითი: string

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

listarray of oneOf
oneOf
ერთ-ერთი ვარიანტი
object (PermissionRoleUserPartner)

მომხმარებელი რეჟიმში partner

idintegerსავალდებულო

მაგალითი: 1

namestring

მაგალითი: John Doe

emailstring

მაგალითი: user@example.com

photostring

მაგალითი: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectსავალდებულო

მომხმარებლის ყველა როლი, დალაგებული როლის id-ის მიხედვით

idintegerსავალდებულო

მაგალითი: 5

namestringსავალდებულო

როლის სახელწოდება როლების ცნობარიდან; მნიშვნელობების ნაკრები ღიაა

მაგალითი: head_of_sales

blockedbooleanსავალდებულო

ბლოკირების გადამრთველის მდგომარეობა

მაგალითი: false

phone_format_idinteger (PhoneFormatId)

ქვეყნის კოდი: 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)

მაგალითი: 1

phone_numberstring

მაგალითი: 9999999999

date_creationstring (DataTimeFormatSQL)

მაგალითი: 2024-05-02 08:31:16

bound_settingsarray of string

მომხმარებელთან დაკავშირებული პარამეტრები წაშლისას გაფრთხილებისთვის; null, თუ არ არსებობს

can_toggle_blockbooleanსავალდებულო

ბლოკირების გადამრთველი ხელმისაწვდომია ამ სტრიქონში მიმდინარე მომხმარებლისთვის; წესს განსაზღვრავს სერვერი, არ გამოიტანოთ იგი როლების სახელებიდან

მაგალითი: true

can_manage_sessionsbooleanსავალდებულო

მიმდინარე მომხმარებელს შეუძლია ნახოს და დახუროს ამ ჩანაწერის სესიები

მაგალითი: false

paginationobject (Pagination)
max_countintegerსავალდებულო

გვერდზე ელემენტების რაოდენობა

მაგალითი: 30

page_numberintegerსავალდებულო

მიმდინარე გვერდის ნომერი; შეზღუდულია ისე, რომ წანაცვლება არ აღემატებოდეს 1000-ს

მაგალითი: 1

has_nextbooleanსავალდებულო

არის თუ არა შემდეგი გვერდი

მაგალითი: true

has_previousbooleanსავალდებულო

არის თუ არა წინა გვერდი

მაგალითი: false