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