API

Mendapatkan daftar pengguna atau satu pengguna

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

Tanpa id, mengembalikan daftar pengguna secara paginasi dengan entri singkat. Dengan id, entri lengkap pengguna dikembalikan di data.list[0], tanpa paginasi dan filter. Mode (partner atau affiliate) ditentukan server berdasarkan sesi. Filter berdasarkan peran (permission_role_id) dan pencarian berdasarkan nama (name) bersifat opsional.

Otorisasi

api-token + language + role

Parameter permintaan

idinteger

Jika diberikan, satu entri lengkap akan dikembalikan tanpa paginasi

Contoh: 1

permission_role_idinteger

Contoh: 1

namestring

Semua mode; substring nama pengguna (nama depan dan belakang) tanpa memperhatikan huruf besar/kecil

Contoh: Alina

page_numberinteger

Contoh: 1

Tanggapan

OK

object
statusstringwajib

Nilai:successerror

Contoh: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Contoh: example

typestringwajib

Contoh: select

optionarray of object
valuestringwajib

Contoh: example

namestringwajib

Contoh: All

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

account_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object
valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

nameobject (FilterInput)
valuestring

Contoh: example

typestringwajib

Contoh: integer or string

placeholderstring

Contoh: string

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

listarray of oneOf
oneOf
Salah satu pilihan
object (PermissionRoleUserPartner)

Pengguna dalam mode partner

idintegerwajib

Contoh: 1

namestring

Contoh: John Doe

emailstring

Contoh: user@example.com

photostring

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

permission_rolesarray of objectwajib

Semua peran pengguna, diurutkan berdasarkan id peran

idintegerwajib

Contoh: 5

namestringwajib

Nama peran dari referensi peran; kumpulan nilai terbuka

Contoh: head_of_sales

blockedbooleanwajib

Status saklar pemblokiran

Contoh: false

phone_format_idinteger (PhoneFormatId)

Kode negara: 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)

Contoh: 1

phone_numberstring

Contoh: 9999999999

date_creationstring (DataTimeFormatSQL)

Contoh: 2024-05-02 08:31:16

bound_settingsarray of string

Pengaturan terkait pengguna untuk peringatan saat penghapusan; null jika tidak ada

can_toggle_blockbooleanwajib

Sakelar blokir tersedia di baris ini untuk pengguna saat ini; aturan ditentukan oleh server, jangan simpulkan dari nama peran

Contoh: true

can_manage_sessionsbooleanwajib

Pengguna saat ini dapat melihat dan menutup sesi dari baris ini

Contoh: false

paginationobject (Pagination)
max_countintegerwajib

Jumlah item per halaman

Contoh: 30

page_numberintegerwajib

Nomor halaman saat ini; dibatasi agar offset tidak melebihi 1000

Contoh: 1

has_nextbooleanwajib

Apakah ada halaman berikutnya

Contoh: true

has_previousbooleanwajib

Apakah ada halaman sebelumnya

Contoh: false