Member

Path /{member-id}

Represents a user object as a member of a Workplace community or group.

Path /community/members

Returns list of all current user accounts. Requires Manage work profiles permission.

Filtering based on external_id

To filter users based on external ID, use the external_ids parameter and pass a comma separated list of external IDs of the desired users.

Path /community/organization_members

Returns list of users. Requires Read group membership permission. By default, active user accounts will be listed. Deactivated user accounts can be shown instead by using the inactive=1 URL parameter.

Reading

Returns a single User object representing a Workplace user. Can be accessed via the member's Workplace ID or the email address used by the member when logging into Workplace.

• /{member_id}
• /{email_address}

Permissions

Reading information about a member requires either Read work profile or Manage accounts permission. If an Integration is using Manage accounts permission and is scoped to specific groups it will not be able to access some Member fields.

Fields

Publishing

See Account Management API (Graph)

Deleting

See Account Management API (Graph)

Updating

See Account Management API (Graph)

Edges

Examples

Retrieving information about a community member

Get the name and email address of a given member.

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

Get a member's ID from their email address

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

List company members based on external id of users

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

List company members including deactivated accounts

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

Get a member's events:

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

Retrieving information about the user's Manager and Reports

Get a given member's reports

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

Get a given member's manager

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

Retrieving messages for a member

Get conversations for a member, including messages, sender and attachments:

Requires custom integration token with Read all messages permission:

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

Get conversation thread IDs for a member by thread:

Requires custom integration token with Read all messages permission:

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

Get messages for a given thread ID, for a given user:

Requires custom integration token with Read all messages permission:

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

Get conversations for a bot page, including messages and attachments:

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

Delete a specific message in a member's inbox using a custom integration token:

Requires custom integration token with Delete chat messages permission

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

Get the date and time when a member was invited and claimed their account:

Requires custom integration token with Manage Accounts permission:

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

Get the date and time when a member's account was deactivated:

Requires custom integration token with Manage Accounts permission:

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

Log a user out of Workplace

Requires access token token with Logout permission:

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

Set a profile picture

Requires access token token with Manage Work Profiles permission. Supports both a file URL and file upload within the request.

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

Add a member's phone

Requires access token token with Manage Work Profiles permission.

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

Get member's skills

Requires access token token with Read Work Profile permission.

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

Add a skill

Requires access token token with Manage Work Profile permission.

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

Remove a skill

Requires access token token with Manage Work Profile permission.

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

Get member's badges

Requires access token token with Read Work Profile permission.

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

Award a built in badge to a user

Requires access token token with Manage badges permission. See community documentation for listing available badges and their IDs.

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

Award a custom badge to a user

Requires access token token with Manage badges permission. See community documentation for listing available badges and their IDs. Note that the # in the URL needs to be URL encoded.

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

Deactivate a member

Requires access token token with Provision User Accounts permission.

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

Delete a member

Requires access token token with Provision User Accounts permission.

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

Get user's frontline status

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