Reference

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 job title on Workplace.

string

department

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

string

employee_number

Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.

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

account_invite_time

Account invite time in UTC format.

datetime

account_claim_time

Account claim time in UTC format.

datetime

impersonate_token

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

Impersonate is a deprecated permission. Do not build new functionality using this permission. This permission can no longer be added to custom integrations.

string

about

The contents of the Bio field in the user profile.

string

frontline

Information about the user's frontline status

object (see example below)

Publishing

You can't publish using this node.

Deleting

You can't delete using this node.

Updating

You can't update using this node. Accounts can be updated or deactivated using the Account Management API.

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

/managers

A person's listed manager or managers.

/reports

A person's listed reports.

/picture

The member's profile pictures.

/groups

Groups associated with a member.

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


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

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 user's frontline status

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