Dieses Dokument wurde aktualisiert.
Die Übersetzung ins Deutsche ist noch nicht fertig.
Englisch aktualisiert: 12.08.2025

Workplace from Meta wird eingestellt. Du kannst Workplace noch bis zum 31. August 2025 nutzen. Weitere Informationen dazu findest du in unserem Hilfebereich.

Mitglied

Pfad /{member-id}

Repräsentiert ein Nutzer*innenobjekt als Mitglied einer Workplace-Community oder -Gruppe.

Pfad /community/members

Gibt eine Liste aller aktuellen Nutzer*innenkonten zurück. Erfordert die Berechtigung Arbeitsprofile verwalten.

Filterung anhand von external_id

Um Nutzer*innen nach einer externen ID zu filtern, kannst du den Parameter external_ids verwenden und eine kommagetrennte Liste der externen IDs der gewünschten Nutzer*innen übergeben.

Pfad /community/organization_members

Gibt eine Liste der Nutzer*innen zurück. Erfordert die Berechtigung Gruppenmitgliedschaft lesen. Standardmäßig werden aktive Nutzer*innenkonten aufgelistet. Verwende den URL-Parameter inactive=1, um stattdessen deaktivierte Nutzer*innenkonten anzuzeigen.

Lesen

Gibt ein einzelnes User-Objekt zurück, das eine*n Workplace-Nutzer*in repräsentiert. Kann entweder über die Workplace-ID des Mitglieds oder über die E-Mail-Adresse abgerufen werden, mit der sich das Mitglied beim Workplace anmeldet.

  • /{member_id}
  • /{email_address}

Berechtigungen

Um Informationen über Mitglieder lesen zu können, brauchst du eine der Berechtigungen Arbeitsprofil lesen oder Konten verwalten. Wenn eine Integration die Berechtigung Konten verwalten verwendet und auf bestimmte Gruppen beschränkt ist, hat sie keinen Zugriff auf bestimmte Mitgliedsfelder.

Felder

Name des FeldesBeschreibungTyp

id

Die ID des Nutzer*innenkontos dieser Person.

string

first_name

Der Vorname der Person.

string

last_name

Der Nachname der Person.

string

email

Die primäre E-Mail-Adresse der Person, dient auch als Nutzer*innenname in Workplace.

string

title

Der Titel der Person in Workplace, falls dieser Wert über die Account Management API festgelegt wurde.

string

organization

Die Organisation der Person in Workplace, falls dieser Wert über die Account Management API festgelegt wurde.

string

division

Die Abteilung der Person in Workplace, falls dieser Wert über die Account Management API festgelegt wurde.

string

department

Der Name der Abteilung der Person in Workplace, falls dieser Wert über die Account Management API festgelegt wurde.

string

primary_phone

Die primäre aufgeführte Telefonnummer der Person. Wird demjenigen phoneNumbers-Eintrag zugeordnet, der in der Account Management API als primary markiert ist.

string

primary_address

Die primäre aufgeführte Adresse der Person. Wird demjenigen addresses-Eintrag zugeordnet, der in der Account Management API als primary markiert ist.

string

picture

Das Profilbild der Person.

url

link

Ein Link zum Profil der Person.

url

locale

Das Gebietsschema der Person.

string

name

Der Vollständige Name der Person.

string

name_format

Der Name der Person im korrekten Format für die chinesische, japanische oder koreanische Reihenfolge.

string

updated_time

Aktualisierungszeit

datetime

account_invite_time

Einladungszeitpunkt des Kontos im UTC-Format.

datetime

account_claim_time

Beanspruchungszeitpunkt des Kontos im UTC-Format.

datetime

account_deactivate_time

Deaktivierungszeitpunkt des Kontos im UTC-Format.

datetime

external_id

Eine ID für das Mitglied gemäß der Definition durch den Kunden. Jedes Mitglied kann einen nicht leeren „external_id“-Wert enthalten, der mit der Account Management API festgelegt wurde. Der Wert des „external_Id“-Attributs wird nie von Workplace vorgegeben.

string

start_date

Datum und Uhrzeit, an denen die Person dem Unternehmen beigetreten ist, falls dieser Wert über die Account Management API festgelegt wurde.

datetime

about

Die Biografie der Person.

string

cost_center

Identifiziert den Namen einer Kostenstelle.

string

impersonate_token

Ein Mitglieder-Zugriffstoken, mit dem eine Integration Aufrufe im Namen einer bestimmten Person ausführen kann.

Die Berechtigung „Nachahmung“ ist als veraltet markiert. Erstelle keine neue Funktionen, die diese Berechtigung verwenden. Diese Berechtigung ist nur für selbstdefinierte Integrationen verfügbar, in denen sie derzeit aktiviert ist.

string

claim_link

Gibt einen Link zurück, dem ein*e Nutzer*in folgen kann, um ihr Workplace-Konto zu beanspruchen (nur verfügbar für nicht beanspruchte Nutzer*innen).

string

access_code

Gibt einen Zugriffscode zurück, dem ein*e Nutzer*in folgen kann, um ihr Workplace-Konto zu beanspruchen (nur verfügbar für nicht beanspruchte Nutzer*innen).

string

work_locale

Das Gebietsschema eines*r Nutzer*in. Workplace verwendet dieses Gebietsschema für diese Person, bis das tatsächliche Gebietsschema der Person auf eine andere Weise ermittelt werden kann (etwa über einen Browser oder die Spracheinstellung eines Geräts).

string Gültige Werte bestehen aus einer Verkettung des zweistelligen ISO 639-1-Sprachcodes plus einem Unterstrich plus dem zweistelligen ISO 3166-1-Ländercode. Beispielsweise gibt en_US die englische Sprache und das Land USA an.

frontline

Informationen über den Frontline-Status der Person.

object (siehe Beispiel unten)

active

Gibt an, ob das Nutzer*innenkonto aktiv ist.

boolean

Veröffentlichen

Siehe Account Management API (Graph)

Edges

Edge-NameBeschreibung

/events

Events für diese Person. Umfasst standardmäßig keine Events, die die Person abgelehnt oder nicht beantwortet hat.

/feed

Der Beitrags-Feed (inklusive Status-Updates) und die Links, die diese Person veröffentlicht hat.

/conversations

Die Workplace-Messages einer Person oder einer Bot-Seite. Erfordert die Berechtigung Alle Nachrichten lesen, um die Unterhaltungen einer Person ansehen zu können.

/managers

Der oder die aufgeführten Manager*innen einer Person.

/reports

Die aufgeführten Berichte einer Person.

/photos

Die Profilbilder des Mitglieds.

/groups

Die einem Mitglied zugeordneten Gruppen.

/phones

Die einem Mitglied zugeordneten Telefonnummern.

/skills

Die Fähigkeiten des Mitglieds.

/badges

Die Abzeichen, die der Person verliehen wurden.

/logout

Meldet eine Person aus Workplace ab. Nur POST

/remove_profile_information

Entfernt die Profilinformationen eines* deaktivierten Nutzer*in. Nur POST

Beispiele

Informationen über ein Community-Mitglied abrufen


Name und E-Mail-Adresse eines Mitglieds abrufen

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


Mitglieds-ID über die E-Mail-Adresse abrufen

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


Unternehmensmitglieder über die externen IDs der Nutzer*innen abrufen

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


Unternehmensmitglieder inklusive deaktivierter Konten abrufen

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


Events eines Mitglieds abrufen:

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

Informationen über den*die Manager*in und die Berichte eines*einer Nutzer*in abrufen


Berichte eines Mitglieds abrufen

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


Manager*in eines Mitglieds abrufen

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

Nachrichten für ein Mitglied abrufen


Unterhaltungen für ein Mitglied abrufen, inklusive Nachrichten, Absender*innen und Anhänge

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Alle Nachrichten lesen:

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


Unterhaltungs-Thread-IDs für ein Mitglied nach Thread abrufen

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Alle Nachrichten lesen:

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


Nachrichten für eine bestimmte Thread-ID für eine*n Nutzer*in abrufen

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Alle Nachrichten lesen:

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


Unterhaltungen für eine Bot-Seite abrufen, inklusive Nachrichten und Anhänge

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

Der Alias /me verweist auf die Seite des Bots, wenn du ein selbstdefiniertes Integrationstoken verwendest.

Eine bestimmte Nachricht im Postfach eines Mitglieds mit einem selbstdefinierten Integrationstoken löschen:

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Chat-Nachrichten löschen:

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

Bei diesem Löschvorgang wird die Nachricht nur aus der Ansicht des in der Anfrage angegebenen Mitglieds gelöscht. Um die Nachricht vollständig zu löschen, müssen die Ansichten aller Mitglieder für diese Nachricht gelöscht werden.


Datum und Uhrzeit abrufen, zu denen ein Mitglied eingeladen wurde und das Konto beansprucht hat:

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Konten verwalten:

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

Diese Felder existieren nur, wenn das Mitglied eingeladen wurde oder das Konto beansprucht hat.


Datum und Uhrzeit abrufen, zu denen ein Mitglied eingeladen wurde und das Konto beansprucht hat:

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Konten verwalten:

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

Diese Felder existieren nur, wenn das Konto des Mitglieds deaktiviert wurde.


Nutzer*in aus Workplace abmelden

Erfordert ein Zugriffstoken mit der Berechtigung Abmeldung:

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


Profilbild festlegen

Erfordert ein Zugriffstoken mit der Berechtigung Arbeitsprofile verwalten. Unterstützt sowohl eine Datei-URL als auch einen Datei-Upload in der Anfrage.

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


Telefon eines Mitglieds hinzufügen

Erfordert ein Zugriffstoken mit der Berechtigung Arbeitsprofile verwalten.

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


Fähigkeiten eines Mitglieds abrufen

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Arbeitsprofil lesen.

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


Fähigkeit hinzufügen

Erfordert ein Zugriffstoken mit der Berechtigung Arbeitsprofil verwalten.

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


Fähigkeit entfernen

Erfordert ein Zugriffstoken mit der Berechtigung Arbeitsprofil verwalten.

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


Abzeichen eines Mitglieds abrufen

Erfordert ein selbstdefiniertes Integrationstoken mit der Berechtigung Arbeitsprofil lesen.

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


Nutzer*in ein integriertes Abzeichen verleihen

Erfordert ein Zugriffstoken mit der Berechtigung Abzeichen verwalten. Unter Community findest du eine Liste der verfügbaren Abzeichen und deren IDs.

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


Nutzer*in ein selbstdefiniertes Abzeichen verleihen

Erfordert ein Zugriffstoken mit der Berechtigung Abzeichen verwalten. Unter Community findest du eine Liste der verfügbaren Abzeichen und deren IDs. Beachte, dass das # in der URL für URLs codiert werden muss.

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


Mitglied deaktivieren

Erfordert ein Integrationstoken mit der Berechtigung Nutzerkonten bereitstellen.

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


Mitglied löschen

Erfordert ein Integrationstoken mit der Berechtigung Nutzerkonten bereitstellen.

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

Nur nicht beanspruchte Mitglieder können gelöscht werden.

Frontline-Status einer Person abrufen

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