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/:memberIdAuthentification
Créez une clé d'API depuis les réglages de l'organisation :
/orgs/{orgSlug}/settings/api-keysEnvoyez la clé dans l'en-tête x-api-key :
x-api-key: VOTRE_CLE_APIL'authentification par jeton porteur est également acceptée :
Authorization: Bearer VOTRE_CLE_APIParamètre d'URL
| Paramètre | Type | Description |
|---|---|---|
memberId | chaîne | Identifiant de l'appartenance à l'organisation |
Réponse
| Champ | Type | Description |
|---|---|---|
member | objet | Membre de l'organisation de la clé |
Objet membre
| Champ | Type | Description |
|---|---|---|
id | chaîne | Identifiant de l'appartenance à l'organisation |
role | chaîne | Rôle du membre, par exemple owner |
createdAt | nombre | Date d'ajout, en millisecondes |
user.id | chaîne | Identifiant de l'utilisateur |
user.name | chaîne | Nom affiché |
user.email | chaîne | Adresse électronique |
user.image | chaîne | null | URL de la photo |
Exemples
cURL
curl -H "x-api-key: VOTRE_CLE_API" \
https://chambree.fr/api/v1/members/member_123JavaScript
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
| Statut | Description |
|---|---|
401 | Clé absente, invalide, expirée ou restreinte |
404 | L'organisation de la clé ou le membre demandé n'existe plus |
500 | Erreur interne du serveur |