API/API Membre d'une organisation

API Membre d'une organisation

Récupérer un membre d'une organisation avec une clé d'API.

Renvoie un membre de l'organisation à laquelle appartient la clé d'API. Une clé est rattachée à une seule organisation : seul l'identifiant du membre est à transmettre.

Utilisez GET /api/v1/members pour la liste complète des membres. Utilisez GET /api/v1/me pour obtenir l'identifiant, le nom ou le slug de l'organisation de la clé.

Point d'entrée

GET /api/v1/members/:memberId

Authentification

Créez une clé d'API depuis les réglages de l'organisation :

/orgs/{orgSlug}/settings/api-keys

Envoyez la clé dans l'en-tête x-api-key :

x-api-key: VOTRE_CLE_API

L'authentification par jeton porteur est également acceptée :

Authorization: Bearer VOTRE_CLE_API

Paramètre d'URL

ParamètreTypeDescription
memberIdchaîneIdentifiant de l'appartenance à l'organisation

Réponse

ChampTypeDescription
memberobjetMembre de l'organisation de la clé

Objet membre

ChampTypeDescription
idchaîneIdentifiant de l'appartenance à l'organisation
rolechaîneRôle du membre, par exemple owner
createdAtnombreDate d'ajout, en millisecondes
user.idchaîneIdentifiant de l'utilisateur
user.namechaîneNom affiché
user.emailchaîneAdresse électronique
user.imagechaîne | nullURL de la photo

Exemples

cURL

curl -H "x-api-key: VOTRE_CLE_API" \
  https://chambree.fr/api/v1/members/member_123

JavaScript

const response = await fetch("https://chambree.fr/api/v1/members/member_123", {
  headers: {
    "x-api-key": process.env.CHAMBREE_API_KEY!,
  },
});

if (!response.ok) {
  throw new Error(
    `Appel /api/v1/members/:memberId en échec : ${response.status}`,
  );
}

const data = await response.json();

Erreurs

StatutDescription
401Clé absente, invalide, expirée ou restreinte
404L'organisation de la clé ou le membre demandé n'existe plus
500Erreur interne du serveur
API Liste des membresAPI Outils