API de la liste des membres
Listez les membres d’une organisation avec une clé API.
Liste les membres de l’organisation propriétaire de la clé API. L’identifiant de l’organisation n’est pas nécessaire.
Utilisez GET /api/v1/me pour identifier l’organisation et GET /api/v1/members/:memberId pour récupérer un membre précis.
Point d’entrée
GET /api/v1/membersAuthentification
Créez une clé API depuis les paramètres de l’organisation :
/orgs/{orgSlug}/settings/api-keysEnvoyez-la dans l’en-tête x-api-key :
x-api-key: YOUR_API_KEYL’authentification Bearer est également acceptée :
Authorization: Bearer YOUR_API_KEYRéponse
| Champ | Type | Description |
|---|---|---|
members | array | Membres de l’organisation |
count | number | Nombre de membres sur cette page |
nextCursor | string | null | Curseur de la page suivante |
hasMore | boolean | Indique si une autre page existe |
Passez limit (de 1 à 100, 50 par défaut) et le nextCursor de la réponse précédente pour parcourir une grande organisation.
Objet membre
| Champ | Type | Description |
|---|---|---|
id | string | Identifiant de l’adhésion |
role | string | Rôle, par exemple owner |
createdAt | number | Date de création en millisecondes |
user.id | string | Identifiant utilisateur |
user.name | string | Nom affiché |
user.email | string | Adresse e-mail |
user.image | string | null | URL de l’avatar |
Exemples
cURL
curl -H "x-api-key: YOUR_API_KEY" \
https://ndd-seo.fr/api/v1/membersJavaScript
const response = await fetch("https://ndd-seo.fr/api/v1/members", {
headers: {
"x-api-key": process.env.NOWSTACK_API_KEY!,
},
});
if (!response.ok) {
throw new Error(`Échec de l’API des membres : ${response.status}`);
}
const data = await response.json();Erreurs
| Statut | Description |
|---|---|
401 | Clé absente, non valide, expirée ou limitée |
404 | L’organisation ou le membre demandé n’existe plus |
500 | Erreur interne du serveur |