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