API

Obtenir la liste des utilisateurs ou un utilisateur

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

Sans id, retourne une liste paginée d'utilisateurs avec des enregistrements abrégés. Avec id, l'enregistrement complet de l'utilisateur est retourné dans data.list[0], sans pagination ni filtres. Le mode (partner ou affiliate) est défini par le serveur selon la session. Le filtre par rôle (permission_role_id) et la recherche par nom (name) sont facultatifs.

Autorisation

api-token + language + role

Paramètres de requête

idinteger

Si ce paramètre est transmis, un seul enregistrement complet est renvoyé sans pagination

Exemple: 1

permission_role_idinteger

Exemple: 1

namestring

Tous les modes ; sous-chaîne du nom d'utilisateur (prénom et nom), insensible à la casse

Exemple: Alina

page_numberinteger

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
modeobject (FilterSelect)
valuestring

Exemple: example

typestringobligatoire

Exemple: select

optionarray of object
valuestringobligatoire

Exemple: example

namestringobligatoire

Exemple: All

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

account_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

affiliate_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

permission_role_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

nameobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of oneOf
oneOf
L'une des options
object (PermissionRoleUserPartner)

Utilisateur en mode partner

idintegerobligatoire

Exemple: 1

namestring

Exemple: John Doe

emailstring

Exemple: user@example.com

photostring

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

permission_rolesarray of objectobligatoire

Tous les rôles de l'utilisateur, triés par id du rôle

idintegerobligatoire

Exemple: 5

namestringobligatoire

Nom du rôle issu du référentiel des rôles ; ensemble de valeurs ouvert

Exemple: head_of_sales

blockedbooleanobligatoire

État de l'interrupteur de blocage

Exemple: false

phone_format_idinteger (PhoneFormatId)

Code du pays : 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)

Exemple: 1

phone_numberstring

Exemple: 9999999999

date_creationstring (DataTimeFormatSQL)

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

bound_settingsarray of string

Paramètres liés à l'utilisateur pour l'avertissement lors de la suppression ; null s'ils sont absents

can_toggle_blockbooleanobligatoire

Le commutateur de blocage est disponible dans cette ligne pour l'utilisateur actuel ; la règle est déterminée par le serveur, ne l'inférez pas à partir des noms de rôles

Exemple: true

can_manage_sessionsbooleanobligatoire

L'utilisateur actuel peut afficher et fermer les sessions de cette ligne

Exemple: false

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false