Membre

Chemin `/{member-id}`

Représente un objet utilisateur comme un membre d’une communauté ou d’un groupe Workplace.

Chemin `/community/members`

Renvoie la liste de tous les comptes utilisateur·ice actuels. Nécessite l’autorisation Gérer les profils professionnels.

Filtrage selon le critère `external_id`

Pour filtrer les utilisateur·ices selon leur ID externe, utilisez le paramètre external_ids et transmettez une liste des ID externes des utilisateur·ices concerné·es séparés par une virgule.

Chemin `/community/organization_members`

Renvoie une liste des utilisateur·ices. Nécessite l’autorisation Consulter les membres du groupe. Par défaut, la liste répertorie les comptes utilisateur actifs. Pour afficher les comptes utilisateur désactivés à la place, utilisez le paramètre URL inactive=1.

Lecture

Renvoie un seul objet Utilisateur représentant un·e utilisateur·ice de Workplace. Pour y accéder, utilisez l’ID Workplace du membre ou l’adresse e-mail qu’il utilise pour se connecter à Workplace.

/{member_id}
/{email_address}

Autorisations

Pour consulter les informations d’un membre, vous devez disposer de l’une des autorisations suivantes : Consulter le profil professionnel ou Gérer les comptes. Si une intégration utilise l’autorisation Gérer les comptes et cible certains groupes, elle ne pourra pas accéder à certains champs Membre.

Champs

Nom du champ	Description	Type
`id`	ID du compte utilisateur de cette personne.	`string`
`first_name`	Prénom de la personne.	`string`
`last_name`	Nom de famille de la personne.	`string`
`email`	Adresse e-mail principale de la personne, également utilisée comme nom d’utilisateur dans Workplace.	`string`
`title`	Titre de la personne dans Workplace, s’il est configuré via l’API Account Management.	`string`
`organization`	Organisation de la personne dans Workplace, si elle est configurée via l’API Account Management.	`string`
`division`	Division de la personne dans Workplace, si elle est configurée via l’API Account Management.	`string`
`department`	Nom du service de la personne dans Workplace, s’il est configuré via l’API Account Management.	`string`
`primary_phone`	Numéro de téléphone principal de la personne. Lié à l’entrée `phoneNumbers` définie comme `primary` dans l’API Account Management.	`string`
`primary_address`	Adresse principale de la personne. Liée à l’entrée `addresses` définie comme `primary` dans l’API Account Management.	`string`
`picture`	Image de profil de la personne.	`url`
`link`	Lien vers le profil de la personne.	`url`
`locale`	Paramètres régionaux de la personne.	`string`
`name`	Nom complet de la personne.	`string`
`name_format`	Nom de la personne formaté de sorte à respecter l’ordre en chinois, japonais ou coréen.	`string`
`updated_time`	Heure de mise à jour.	`datetime`
`account_invite_time`	Heure de l’invitation à créer un compte au format UTC.	`datetime`
`account_claim_time`	Heure de réclamation du compte au format UTC.	`datetime`
`account_deactivate_time`	Heure de désactivation du compte au format UTC.	`datetime`
`external_id`	Identifiant du membre défini par le ou la client·e. Chaque membre PEUT inclure un ensemble de valeurs external_id non vide avec l’API Account Management. La valeur de l’attribut external_id ne sera jamais spécifiée par Workplace.	`string`
`start_date`	Date et heure auxquelles la personne a intégré l’entreprise, si elles sont configurées via l’API Account Management.	`datetime`
`about`	Bio de la personne.	`string`
`cost_center`	Nom d’un centre de coût.	`string`
`impersonate_token`	Token d’accès de membre qui permet à une intégration d’effectuer des appels au nom d’une personne donnée. Cette autorisation est obsolète. Ne créez pas de nouvelle fonctionnalité reposant sur cette autorisation. Seules les intégrations personnalisées pour lesquelles cette autorisation est actuellement activée peuvent encore l’utiliser.	`string`
`claim_link`	Obtient un lien qu’un·e utilisateur·ice peut suivre pour réclamer son compte Workplace (disponible uniquement pour les utilisateur·ices n’ayant pas réclamé leur compte).	`string`
`access_code`	Obtient un code d’accès qu’un·e utilisateur·ice peut saisir pour réclamer son compte Workplace (disponible uniquement pour les utilisateur·ices n’ayant pas réclamé leur compte).	`string`
`work_locale`	Paramètres régionaux de l’utilisateur·ice. Workplace utilisera ces paramètres régionaux pour l’utilisateur·ice tant que le système ne détectera pas d’autres paramètres régionaux de l’utilisateur·ice (comme les paramètres linguistiques de son appareil ou du navigateur).	`string` Les valeurs valides sont une concaténation du code de langue à deux lettres ISO 639-1, d’un trait de soulignement et de l’indicatif pays à deux lettres ISO 3166-1. Par exemple, fr_FR indique la langue française et le pays France.
`frontline`	Informations relatives au statut sur le terrain de l’utilisateur·ice.	`object` (voir l’exemple ci-dessous)
`active`	Indique si le compte est actif ou non.	`boolean`

Publication

Consultez API Account Management (Graph)

Suppression

Consultez API Account Management (Graph).

Mise à jour

Consultez API Account Management (Graph).

Arêtes

Nom de l’arête	Description
`/events`	Évènements de cette personne. Par défaut, les évènements refusés par la personne ou laissés sans réponse sont exclus.
`/feed`	Fil des publications (y compris les mises à jour de statut) et liens publiés par cette personne.
`/conversations`	Messages Workplace d’une personne ou d’une page de bot. Nécessite l’autorisation Lire tous les messages pour afficher les conversations d’une personne.
`/managers`	Responsable(s) d’une personne.
`/reports`	Personnes sous la responsabilité d’une autre personne.
`/photos`	Images de profil du membre.
`/groups`	Groupes auxquels appartient un membre.
`/phones`	Numéros de téléphone associés à un membre.
`/skills`	Compétences d’un membre.
`/badges`	Badges remportés par l’utilisateur·ice.
`/logout`	Déconnecte un·e utilisateur·ice de Workplace. `POST` uniquement.
`/remove_profile_information`	Supprime les informations de profil d’un·e utilisateur·ice désactivé·e. `POST` uniquement.

Exemples

Récupérer les informations concernant le membre d’une communauté

Obtenir le nom et l’adresse e-mail d’un membre

GET /{member_id}?fields=email,name HTTP/1.1
Host: graph.facebook.com

Obtenir l’ID d’un membre à partir de son adresse e-mail

GET /{email_address} HTTP/1.1
Host: graph.facebook.com

Obtenir la liste des membres de l’entreprise à partir des ID externes des utilisateur·ices

GET /community/members?external_ids=12356,abc123 HTTP/1.1
Host: graph.facebook.com

Obtenir la liste des membres de l’entreprise, y compris les comptes désactivés

GET /community/organization_members?inactive=1 HTTP/1.1
Host: graph.facebook.com

Obtenir les évènements d’un membre

GET graph.facebook.com
      /{member-id}/events

Récupérer les informations concernant les responsables et les subordonnés d’un·e utilisateur·ice

Obtenir la liste des subordonnés d’un membre

GET /{member_id}/reports HTTP/1.1
Host: graph.facebook.com

Obtenir la liste des responsables d’un membre

GET /{member_id}/managers HTTP/1.1
Host: graph.facebook.com

Récupérer les messages d’un membre

Obtenir les conversations d’un membre, y compris ses messages, leur expéditeur et les pièces jointes

Nécessite le token d’intégration personnalisée avec l’autorisation Lire tous les messages.

GET graph.facebook.com
      /{member-id}/conversations?fields=messages{message,attachments,from}

Obtenir les ID des fils de conversation d’un membre, par fil de discussion

Nécessite un token d’intégration personnalisée avec l’autorisation Lire tous les messages.

GET graph.facebook.com
      /{member-id}/conversations

Obtenir les messages d’un ID de fil de discussion d’un·e utilisateur·ice

Nécessite le token d’intégration personnalisée avec l’autorisation Lire tous les messages :

GET graph.facebook.com
      /{thread-id}/messages?user={user-id}

Obtenir les conversations d’une page de bot, y compris les messages et les pièces jointes

GET graph.facebook.com
      /me/conversations?fields=messages{message,attachments}

L’alias /me réfère à la page du bot quand un token d’intégration personnalisée est utilisé.

Supprimer un message dans la messagerie d’un ou d’une membre avec un token d’intégration personnalisée

Nécessite le token d’intégration personnalisée avec l’autorisation Supprimer les messages d’une discussion.

DELETE graph.facebook.com
      /{message-id}?user={user-id}

Le message disparaît uniquement de la messagerie du membre spécifié dans la requête. Les autres membres disposant du message peuvent toujours le voir. Pour supprimer définitivement le message, vous devez le supprimer pour tous les membres concerné·e·s.

Obtenir la date et l’heure auxquelles un ou une membre a été invité·e et a réclamé son compte

Nécessite le token d’intégration personnalisée avec l’autorisation Gérer les comptes.

GET graph.facebook.com
      /{member-id}?fields=account_invite_time,account_claim_time

Ces champs sont présents uniquement si le ou la membre a été invité·e ou a réclamé son compte.

Obtenir la date et l’heure auxquelles le compte d’un ou d’une membre a été désactivé

Nécessite le token d’intégration personnalisée avec l’autorisation Gérer les comptes.

GET graph.facebook.com
      /{member-id}?fields=account_deactivate_time

Ces champs sont présents uniquement si le compte d’un ou d’une membre a été désactivé.

Déconnecter un·e utilisateur·ice de Workplace

Nécessite un token d’accès avec l’autorisation Déconnexion.

POST graph.facebook.com
      /{member-id}/logout

Configurer une image de profil

Nécessite un token d’accès avec l’autorisation Gérer les profils professionnels. L’URL et l’importation d’un fichier sont toutes deux acceptées dans la requête.

POST graph.facebook.com
      /{member-id}/profile_pictures?
      image_url={...}&
      caption={...}

POST graph.facebook.com
      /{member-id}/profile_pictures?
      caption={...}
Content-Type: multipart/form-data;
Content-Disposition: form-data; name="image_data"; filename="/profile_picture.png

Ajouter le numéro de téléphone d’un membre

Nécessite un token d’accès avec l’autorisation Gérer les profils professionnels.

POST graph.facebook.com
      /{member-id}/phones?
      type={...}&
      primary={...}&
      number={...}

Obtenir les compétences d’un membre

Nécessite un token d’accès avec l’autorisation Consulter le profil professionnel.

GET graph.facebook.com
      /{member-id}/skills

Ajouter une compétence

Nécessite un token d’accès avec l’autorisation Gérer les profils professionnels.

POST graph.facebook.com
      /{member-id}/skills?name={...}

Supprimer une compétence

Nécessite un token d’accès avec l’autorisation Gérer les profils professionnels.

DELETE graph.facebook.com
      /{member-id}/skills?name={...}

Obtenir les badges d’un membre

Nécessite un token d’accès avec l’autorisation Consulter le profil professionnel.

GET graph.facebook.com
      /{member-id}/badges?fields=id,name,description,icon,category

Attribuer un badge intégré à un·e utilisateur·ice

Nécessite un token d’accès avec l’autorisation Gérer les badges. Consultez la documentation sur la communauté pour obtenir la liste des badges disponibles et leur ID.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_champion

Attribuer un badge personnalisé à un·e utilisateur·ice

Nécessite un token d’accès avec l’autorisation Gérer les badges. Consultez la documentation sur la communauté pour obtenir la liste des badges disponibles et leur ID. Le symbole # doit être encodé au format URL.

POST graph.facebook.com
      /{member-id}/badges?badge=workplace_custom#{badge_id}

Désactiver un membre

Nécessite un token d’accès avec l’autorisation Provisionner les comptes des utilisateurs et utilisatrices.

POST graph.facebook.com
      /{member-id}?active=false

Supprimer un membre

Nécessite un token d’accès avec l’autorisation Provisionner les comptes des utilisateurs.

DELETE graph.facebook.com
      /{member-id}

Seuls les membres n’ayant pas réclamé leur compte peuvent être supprimés.

Obtenir le statut sur le terrain de l’utilisateur ou l’utilisatrice

GET graph.facebook.com
      /{user-id}?fields=frontline
      
    {
      "frontline": {
        "is_frontline": true
      },
    "id": "100038142594104"
    }

Membre

Chemin /{member-id}

Chemin /community/members

Filtrage selon le critère external_id

Chemin /community/organization_members

Lecture

Autorisations

Champs

Publication

Suppression

Mise à jour

Arêtes

Exemples

Récupérer les informations concernant le membre d’une communauté

Obtenir le nom et l’adresse e-mail d’un membre

Obtenir l’ID d’un membre à partir de son adresse e-mail

Obtenir la liste des membres de l’entreprise à partir des ID externes des utilisateur·ices

Obtenir la liste des membres de l’entreprise, y compris les comptes désactivés

Obtenir les évènements d’un membre

Récupérer les informations concernant les responsables et les subordonnés d’un·e utilisateur·ice

Obtenir la liste des subordonnés d’un membre

Obtenir la liste des responsables d’un membre

Récupérer les messages d’un membre

Obtenir les conversations d’un membre, y compris ses messages, leur expéditeur et les pièces jointes

Obtenir les ID des fils de conversation d’un membre, par fil de discussion

Obtenir les messages d’un ID de fil de discussion d’un·e utilisateur·ice

Obtenir les conversations d’une page de bot, y compris les messages et les pièces jointes

Supprimer un message dans la messagerie d’un ou d’une membre avec un token d’intégration personnalisée

Obtenir la date et l’heure auxquelles un ou une membre a été invité·e et a réclamé son compte

Obtenir la date et l’heure auxquelles le compte d’un ou d’une membre a été désactivé

Déconnecter un·e utilisateur·ice de Workplace

Configurer une image de profil

Ajouter le numéro de téléphone d’un membre

Obtenir les compétences d’un membre

Ajouter une compétence

Supprimer une compétence

Obtenir les badges d’un membre

Attribuer un badge intégré à un·e utilisateur·ice

Attribuer un badge personnalisé à un·e utilisateur·ice

Désactiver un membre

Supprimer un membre

Obtenir le statut sur le terrain de l’utilisateur ou l’utilisatrice

Chemin `/{member-id}`

Chemin `/community/members`

Filtrage selon le critère `external_id`

Chemin `/community/organization_members`