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