API/API de la liste des membres

API de la liste des membres

Listez les membres d’une organisation avec une clé API.

Listez les membres de l’organisation propriétaire de la clé. La clé étant limitée à une seule organisation, aucun identifiant d’organisation n’est nécessaire.

Utilisez GET /api/v1/me pour identifier l’organisation et GET /api/v1/members/:memberId pour lire un membre précis.

Endpoint

GET /api/v1/members

Authentification

Envoyez une clé créée dans Paramètres > Clés API :

x-api-key: YOUR_API_KEY

Vous pouvez aussi utiliser :

Authorization: Bearer YOUR_API_KEY

Réponse

ChampTypeDescription
membersarrayMembres de l’organisation de la clé

Objet membre

ChampTypeDescription
idstringIdentifiant de l’adhésion
rolestringRôle, par exemple owner
createdAtnumberDate de création en millisecondes
user.idstringIdentifiant utilisateur
user.namestringNom affiché
user.emailstringAdresse e-mail
user.imagestring | nullURL de l’avatar

Erreurs

StatutDescription
401Clé absente, invalide, expirée ou limitée
404L’organisation associée à la clé n’existe plus
500Erreur interne du serveur