Lister les membres

Un administrateur d'agenda a accès à la liste des membres de l'agenda. Un get à la route suivante suffit:

/v2/agendas/{agendaUid}/members?limit={limit}&after={after}

Important: Une authentification est nécessaire pour cette opération.

Paramètres

  • agendaUid: l'identifiant de l'agenda où se trouve l'événement
  • limit: (par défaut: 20, maximum 100) le nombre d'items à récupérer pour un appel
  • after: Clé de pagination fournie dans la réponse de l'appel précédant pour récupérer les résultats suivants. Le premier appel ne nécessite pas cette clé.

Réponse

  • total: le nombre total de membres
  • items: la liste des membres. Pour chaque membre, les données suivantes sont disponibles, lorsqu'elles ont été saisies en amont des contributions sur l'agenda:
  • uid: identifiant du membre - toujours défini
  • name: nom
  • email: email
  • phone: numéro de téléphone
  • organization: nom de l'organisation à laquelle le membre appartient
  • role: role du membre dans l'agenda (reader, contributor, moderator, administrator)
  • success: booléen indiquant que la requête s'est bien déroulée
  • after: clé à placer dans l'appel suivant pour récupérer la suite des membres