API

Kullanıcıların listesini veya tek bir kullanıcıyı al

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

id olmadan, kullanıcıların sayfalı listesi kısaltılmış satırlarla döner. id ile, tam kullanıcı kaydı data.list[0] içinde, sayfalama ve filtreleme olmadan döner. Mod (partner veya affiliate), sunucu tarafından oturumdan belirlenir. Rol filtresi (permission_role_id) ve isimle arama (name) isteğe bağlıdır.

Yetkilendirme

api-token + language + role

Sorgu parametreleri

idinteger

Eğer iletilirse, sayfalama olmadan tek bir tam kayıt döndürülür

Örnek: 1

permission_role_idinteger

Örnek: 1

namestring

Tüm modlar; kullanıcı adı alt dizesi (ad ve soyad), büyük/küçük harf duyarsız

Örnek: Alina

page_numberinteger

Örnek: 1

Yanıtlar

OK

object
statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Örnek: example

typestringzorunlu

Örnek: select

optionarray of object
valuestringzorunlu

Örnek: example

namestringzorunlu

Örnek: All

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

account_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object
valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

nameobject (FilterInput)
valuestring

Örnek: example

typestringzorunlu

Örnek: integer or string

placeholderstring

Örnek: string

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

listarray of oneOf
oneOf
Seçeneklerden biri
object (PermissionRoleUserPartner)

Kullanıcı partner modunda

idintegerzorunlu

Örnek: 1

namestring

Örnek: John Doe

emailstring

Örnek: user@example.com

photostring

Örnek: data:image/jpeg;base64,/9j/4AAQSkZJRg...

permission_rolesarray of objectzorunlu

Kullanıcının tüm rolleri, rolün id değerine göre sıralanmış

idintegerzorunlu

Örnek: 5

namestringzorunlu

Rol adının referans kitabından alınması; değer kümesi açıktır

Örnek: head_of_sales

blockedbooleanzorunlu

Blokaj anahtarı durumu

Örnek: false

phone_format_idinteger (PhoneFormatId)

Ülke 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)

Örnek: 1

phone_numberstring

Örnek: 9999999999

date_creationstring (DataTimeFormatSQL)

Örnek: 2024-05-02 08:31:16

bound_settingsarray of string

Kullanıcıyla ilişkili, silme sırasında uyarı için ayarlar; yoksa null

can_toggle_blockbooleanzorunlu

Bu satırda mevcut kullanıcı için bloklama anahtarı kullanılabilir; kuralı sunucu belirler, rol adlarından çıkarmayın

Örnek: true

can_manage_sessionsbooleanzorunlu

Geçerli kullanıcı bu satırın oturumlarını görüntüleyebilir ve kapatabilir

Örnek: false

paginationobject (Pagination)
max_countintegerzorunlu

Sayfadaki öğe sayısı

Örnek: 30

page_numberintegerzorunlu

Geçerli sayfa numarası; offset 1000'ü aşmayacak şekilde sınırlandırılmıştır

Örnek: 1

has_nextbooleanzorunlu

Sonraki sayfa var mı

Örnek: true

has_previousbooleanzorunlu

Önceki sayfa var mı

Örnek: false