API

Iegūt lietotāju sarakstu vai vienu lietotāju

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

Bez id tiek atgriezts lietotāju lapots saraksts ar saīsinātiem ierakstiem. Ar id pilns lietotāja ieraksts tiek atgriezts data.list[0] bez lapošanas un filtriem. Režīmu (partner vai affiliate) serveris nosaka pēc sesijas. Filtrs pēc lomas (permission_role_id) un meklēšana pēc vārda (name) nav obligāti.

Autorizācija

api-token + language + role

Vaicājuma parametri

idinteger

Ja tiek nodots, tiek atgriezts viens pilns ieraksts bez lapošanas

Piemērs: 1

permission_role_idinteger

Piemērs: 1

namestring

Visi režīmi; lietotājvārda apakšvirkne (vārds un uzvārds), reģistrnejutīga

Piemērs: Alina

page_numberinteger

Piemērs: 1

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Piemērs: example

typestringobligāts

Piemērs: select

optionarray of object
valuestringobligāts

Piemērs: example

namestringobligāts

Piemērs: All

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

account_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

nameobject (FilterInput)
valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

listarray of oneOf
oneOf
Viens no variantiem
object (PermissionRoleUserPartner)

Lietotājs režīmā partner

idintegerobligāts

Piemērs: 1

namestring

Piemērs: John Doe

emailstring

Piemērs: user@example.com

photostring

Piemērs: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectobligāts

Visas lietotāja lomas, sakārtotas pēc lomas id

idintegerobligāts

Piemērs: 5

namestringobligāts

Lomas nosaukums no lomu katalogā; vērtību kopa ir atvērta

Piemērs: head_of_sales

blockedbooleanobligāts

Bloķēšanas slēdža stāvoklis

Piemērs: false

phone_format_idinteger (PhoneFormatId)

Valsts kods: 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)

Piemērs: 1

phone_numberstring

Piemērs: 9999999999

date_creationstring (DataTimeFormatSQL)

Piemērs: 2024-05-02 08:31:16

bound_settingsarray of string

Ar lietotāju saistītie iestatījumi brīdinājumam dzēšanas laikā; null, ja nav

can_toggle_blockbooleanobligāts

Bloķēšanas pārslēgs šajā rindā ir pieejams pašreizējam lietotājam; noteikumu nosaka serveris, neizseciniet to no lomu nosaukumiem

Piemērs: true

can_manage_sessionsbooleanobligāts

Pašreizējais lietotājs var skatīt un aizvērt šīs rindas sesijas

Piemērs: false

paginationobject (Pagination)
max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false