Member

Path /{member-id}

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

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 all content or Manage accounts permission.

Fields

Field NameDescriptionType

id

The id of this person's user account.

string

first_name

The person's first name.

string

last_name

The person's last name.

string

email

The person's primary email address, also used as their username on Workplace.

string

title

The person's title on Workplace, if set via the Account Management API.

string

organization

The person's organization on Workplace, if set via the Account Management API.

string

division

The person's division on Workplace, if set via the Account Management API.

string

department

The person's department name on Workplace, if set via the Account Management API.

string

primary_phone

The person's primary listed phone number. Maps to the phoneNumbers entry which is marked as primary on the Account Management API.

string

primary_address

The person's primary listed address. Maps to the addresses entry which is marked as primary on the Account Management API

string

picture

The person's profile picture.

url

link

A link to the person's profile.

url

locale

The person's locale.

string

name

The person's full name.

string

name_format

The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering.

string

updated_time

Updated time.

datetime

account_invite_time

Account invite time in UTC format.

datetime

account_claim_time

Account claim time in UTC format.

datetime

external_id

An identifier for the member as defined by the customer. Each member MAY include a non-empty external_id value set using the on the Account Management API. The value of the external_id attribute will never be specified by Workplace.

string

start_date

The date and time which the person joined the company, if set via the Account Management API.

datetime

about

The person's bio.

string

cost_center

Identifies the name of a cost center.

string

impersonate_token

A member access token which allows an integration to make calls on behalf of a specific person.

Impersonate is a deprecated permission. Do not build new functionality using this permission. This permission is not be available to custom integrations which do not currently have it enabled.

string

claim_link

Provides a link which a user can follow to claim their Workplace account (only available for unclaimed users).

string

work_locale

User's locale. This is the locale that Workplace will use for this user until there is another way to determine the user's locale (such as a browser or device language setting)

string Valid values are concatenation of the ISO 639-1 two-letter language code plus an underscore plus the ISO 3166-1 two letter country code.For example, en_US specifies the English language and country US.

Edges

Edge NameDescription

/events

Events for this person. By default this does not include events the person has declined or not replied to.

/feed

The feed of posts (including status updates) and links published by this person.

/conversations

A person or bot page's Workplace Messages. Requires the Read all messages permission for viewing a person's conversations.

/managers

A person's listed manager or managers.

/reports

A person's listed reports.

/photos

The member's profile pictures.

/groups

Groups associated with a member.

/phones

Phone numbers associated with a member.

/skills

The member's skills.

/logout

Log a user out of Workplace. POST only

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


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}

The /me alias points to the bot's page when using a custom integration token

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}

Deleting a message only deletes the message from the view of the member who was specified in the request. To delete a message entirely, each member's view of that message must be deleted.


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

These fields are only present if the member was invited or claimed their account


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={...}


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}

Only unclaimed members are available for deletion.