API/API de la liste des membres

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/members

Authentification

Créez une clé API depuis les paramètres de l’organisation :

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

Envoyez-la dans l’en-tête x-api-key :

x-api-key: YOUR_API_KEY

L’authentification Bearer est également acceptée :

Authorization: Bearer YOUR_API_KEY

Réponse

ChampTypeDescription
membersarrayMembres de l’organisation
countnumberNombre de membres sur cette page
nextCursorstring | nullCurseur de la page suivante
hasMorebooleanIndique 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

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

Exemples

cURL

curl -H "x-api-key: YOUR_API_KEY" \
  https://ndd-seo.fr/api/v1/members

JavaScript

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

StatutDescription
401Clé absente, non valide, expirée ou limitée
404L’organisation ou le membre demandé n’existe plus
500Erreur interne du serveur
API de l’organisation couranteAPI d’un membre de l’organisation