API

Ottenere l'elenco degli utenti o un singolo utente

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

Senza id restituisce un elenco paginato di utenti con record abbreviati. Con id, in data.list[0] viene restituito il record completo dell'utente, senza paginazione né filtri. La modalità (partner o affiliate) viene impostata dal server tramite sessione. Il filtro per ruolo (permission_role_id) e la ricerca per nome (name) sono opzionali.

Autorizzazione

api-token + language + role

Parametri della richiesta

idinteger

Se fornito, viene restituito un singolo record completo senza paginazione

Esempio: 1

permission_role_idinteger

Esempio: 1

namestring

Tutti i ruoli; sottostringa del nome utente (nome e cognome) senza distinzione tra maiuscole e minuscole

Esempio: Alina

page_numberinteger

Esempio: 1

Risposte

OK

object
statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Esempio: example

typestringobbligatorio

Esempio: select

optionarray of object
valuestringobbligatorio

Esempio: example

namestringobbligatorio

Esempio: All

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

account_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object
valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

nameobject (FilterInput)
valuestring

Esempio: example

typestringobbligatorio

Esempio: integer or string

placeholderstring

Esempio: string

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

listarray of oneOf
oneOf
Una delle opzioni
object (PermissionRoleUserPartner)

Utente in modalità partner

idintegerobbligatorio

Esempio: 1

namestring

Esempio: John Doe

emailstring

Esempio: user@example.com

photostring

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

permission_rolesarray of objectobbligatorio

Tutti i ruoli dell'utente, ordinati per id del ruolo

idintegerobbligatorio

Esempio: 5

namestringobbligatorio

Nome del ruolo dal dizionario dei ruoli; l'insieme dei valori è aperto

Esempio: head_of_sales

blockedbooleanobbligatorio

Stato dell'interruttore di blocco

Esempio: false

phone_format_idinteger (PhoneFormatId)

Codice paese: 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)

Esempio: 1

phone_numberstring

Esempio: 9999999999

date_creationstring (DataTimeFormatSQL)

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

bound_settingsarray of string

Impostazioni utente per l'avviso durante l'eliminazione; null se assenti

can_toggle_blockbooleanobbligatorio

L'interruttore di blocco è disponibile in questa riga per l'utente corrente; la regola è determinata dal server, non dedurla dai nomi dei ruoli

Esempio: true

can_manage_sessionsbooleanobbligatorio

L'utente corrente può visualizzare e chiudere le sessioni di questa riga

Esempio: false

paginationobject (Pagination)
max_countintegerobbligatorio

Numero di elementi per pagina

Esempio: 30

page_numberintegerobbligatorio

Numero della pagina corrente; limitato in modo che l'offset non superi 1000

Esempio: 1

has_nextbooleanobbligatorio

Esiste una pagina successiva

Esempio: true

has_previousbooleanobbligatorio

C'è una pagina precedente

Esempio: false