Skip to main content
Les rôles sont soit des rôles système (comme admin ou moderator), soit des rôles custom gérés depuis le tableau de bord. Utilisez l’API Team Members pour lister l’équipe d’un compte, ajouter un utilisateur à l’équipe avec un rôle système, modifier le rôle d’un membre et retirer des membres. L’ajout d’un utilisateur qui n’a pas encore accepté envoie plutôt une invitation.

Endpoints

Attributs

string
requis
ID du membre de l’équipe. Les membres ayant accepté ont un ID commençant par ausr_ ou mber_, et les invitations en attente un ID commençant par ausri_. Traitez-le comme opaque : les deux préfixes de membre sont acceptés partout où un ID de membre de l’équipe l’est.
object
requis
Le compte auquel appartient cette adhésion à l’équipe.

Propriétés

string
requis
ID du compte, préfixé par biz_.
object
Taux de majoration que ce parent facture au sous-compte consulté, indexés par type de frais (par exemple crypto_deposit_markup), chacun avec percentage_fee et fixed_fee_usd. Résolus en donnant la priorité aux remplacements propres au sous-compte sur la valeur par défaut de la plateforme.
string | null
requis
URL de l’image du logo du compte.
string
requis
Identifiant de route publique du compte.
string
requis
Nom d’affichage du compte.
object | null
requis
Rôle personnalisé attribué à ce membre, ou null si le membre a un rôle système.

Propriétés

string
requis
ID du rôle personnalisé, préfixé par aurl_.
string
requis
Nom du rôle personnalisé.
string
requis
Date à laquelle le membre a rejoint l’équipe ou l’invitation a été envoyée, sous forme d’horodatage ISO 8601. Un membre qui était d’abord client conserve la date à laquelle son rôle lui a été attribué.
integer | null
requis
Nombre de membres de l’équipe qui rendent compte directement à ce membre. null pour les invitations.
string | null
requis
L’adresse e-mail du membre. Pour une invitation envoyée à une adresse e-mail qui n’a pas encore de compte Whop, il s’agit de l’adresse invitée. Sinon, la valeur est null sauf si l’appelant dispose du scope company:authorized_user:email:read.
boolean
requis
Indique si ce membre est un agent (compte contrôlé par une app) plutôt qu’un membre humain de l’équipe. Toujours false pour les invitations.
boolean
requis
Indique si ce membre ou cette invitation a le rôle Partner en lecture seule, directement ou via un rôle personnalisé basé sur celui-ci. Un Partner ne peut consulter que les informations de base du compte.
object[] | null
requis
Les responsables au-dessus de ce membre, du plus proche au plus éloigné : le membre auquel il rend compte, puis le responsable de ce membre, jusqu’au sommet de la ligne hiérarchique. [] lorsque le membre rend compte directement à l’entreprise. Un appelant qui ne peut consulter que sa propre ligne hiérarchique la voit s’arrêter à lui-même, et null là où elle ne lui est pas lisible. null pour les invitations.

Propriétés

string
requis
L’ID de membre de l’équipe du responsable, commençant par ausr_ ou mber_ ; traitez-le comme opaque.
object
requis
L’utilisateur derrière l’adhésion à l’équipe du responsable.

Propriétés

string
requis
ID utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent et correspond à un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
string | null
requis
L’ID du membre de l’équipe auquel ce membre rend compte, commençant par ausr_ ou mber_ ; traitez-le comme opaque. null lorsque le membre rend compte directement à l’entreprise, ainsi que pour les invitations.
string
requis
Le rôle du membre sur le compte. custom désigne un rôle sur mesure géré depuis le tableau de bord ; l’API peut le lire mais pas l’attribuer.Options disponibles : owner, admin, partner, sales_manager, moderator, advertiser, app_manager, support, manager, workforce, custom
string
requis
joined pour les membres ayant accepté, pending tant que l’invitation est en attente.Options disponibles : joined, pending
string
requis
Date de la dernière mise à jour de l’adhésion, sous forme d’horodatage ISO 8601.
object | null
requis
L’utilisateur derrière cette adhésion à l’équipe. null pour une invitation envoyée à une adresse e-mail qui n’a pas encore de compte Whop.

Propriétés

string
requis
ID utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent et correspond à un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
TeamMember