}];If you want to learn how to use the Graph API, read our Using Graph API guide.
Field | Description |
---|---|
numeric string | The id of this person's user account. This ID is unique to each app and cannot be used across different apps. Our upgrade guide provides more information about app-specific IDs |
string | Equivalent to the |
| Notes added by viewing page on this person |
| The age segment for this person expressed as a minimum and maximum age. For example, more than 18, less than 21. |
string | A short bio, found on a person's profile in the "About This Person" section |
string | The person's birthday. This is a fixed format string, like |
| Social context for this person |
| The person's cover photo |
| The person's local currency information |
| The list of devices the person is using. This will return only iOS and Android devices |
| The person's education |
string | The person's primary email address listed on their profile. This field will not be returned if no valid email address is available |
string | The person's employee number, as set by the company via SCIM API |
| Athletes the person likes |
| Sports teams the person likes |
string | The person's first name |
string | The gender selected by this person, |
| The person's hometown |
| The person's inspirational people |
enum | Install type |
bool | Is the app making the request installed? |
list<string> | Genders the person is interested in |
bool | Is this a shared login (e.g. a gray user) |
bool | People with large numbers of followers can have the authenticity of their identity manually verified by Facebook. This field indicates whether the person's profile is verified in this way. This is distinct from the |
| Labels applied by viewing page on this person |
| Facebook Pages representing the languages this person knows |
string | The person's last name |
string | A link to the person's Timeline |
string | The person's locale |
| The person's current location as entered by them on their profile. This field is not related to check-ins |
list<string> | What the person is interested in meeting for |
string | The person's middle name |
string | The person's full name |
string | The person's name formatted to correctly handle Chinese, Japanese, or Korean ordering |
numeric string | Page scoped ID for this user. The app must be associated with the page |
| The person's payment pricepoints |
string | The person's political views |
string | The person's PGP public key |
string | The person's favorite quotes |
string | The person's relationship status |
string | The person's religion |
| Security settings |
datetime | The time that the shared loginneeds to be upgraded to Business Manager by |
| The person's significant other |
| Sports played by the person |
unsigned int32 | Platform test group |
string | A string containing an anonymous, but unique identifier for the person. You can use this identifier with third parties |
float (min: -24) (max: 24) | The person's current timezone offset from UTC |
string | A token that is the same across a business's apps. Access to this token requires that the person be logged into your app or have a role on your app. This token will change if the business owning the app changes |
datetime | Updated time |
bool | Indicates whether the account has been verified. This is distinct from the
|
| Video upload limits |
bool | Can the viewer send a gift to this person? |
string | The person's website |
| Details of a person`s work experience |
Edge | Description |
---|---|
Facebook Pages this person administers/is an admin for | |
Achievements made in Facebook games | |
Ad account groups | |
The advertising accounts to which this person has access | |
The person's ad contracts | |
Groups the user admins | |
Insights data for the person's Audience Network apps | |
The photo albums this person has created | |
App requests | |
This person's pending requests from an app | |
The books listed on this person's profile | |
The business activities related to this user | |
The domains the user admins | |
Events for this person. By default this does not include events the person has declined or not replied to | |
This person's family relationships. | |
Developers' favorite requests to the Graph API | |
The person's custom friend lists | |
A person's friends. | |
Games this person likes | |
The Facebook Groups that the person is an admin of | |
Business entities can claim ownership of multiple apps using the Business Manager. This edge returns the list of IDs that this user has in any of those other apps | |
A list of friends that can be invited to install a Facebook Canvas app | |
All the Pages this person has liked | |
Live videos from this person | |
Movies this person likes | |
Music this person likes | |
Objects | |
The permissions that the person has granted this app | |
The advertising accounts to which this person has personal access | |
Photos the person is tagged in or has uploaded | |
The person's profile picture | |
All the domains user can promote | |
All the events which user can promote. | |
Developers' Graph API request history | |
Any session keys that the app knows the user by | |
A list of filters that can be applied to the News Feed edge | |
Friends that can be tagged in content published via the Graph API | |
List of tagged places for this person. It can include tags on videos, posts, statuses or links | |
TV shows this person likes | |
Video broadcasts from this person | |
Videos the person is tagged in or uploaded | |
The checkins this person has made. | |
The feed of posts (including status updates) and links published by this person. | |
A person's pending friend requests. | |
A person's Facebook homepage feed. | |
A person's Facebook Messages inbox. | |
A feed of posts and photos that include location information and in which this person has been tagged. This is useful for constructing a chronology of places that the person has visited. | |
The list of mutual friends between two people. | |
The unread Facebook notifications that a person has. | |
A person's Facebook Messages outbox. | |
The questions that a person has created. | |
The scores this person has received from Facebook Games that they've played. | |
The profiles that are following this person. | |
The profile that this person is following. |
Error | Description |
---|---|
100 | Invalid parameter |
110 | Invalid user id |
210 | User not visible |
289 | Accessing friend requests requires the extended permission read_requests |
278 | Reading advertisements requires an access token with the extended permission ads_read |
294 | Managing advertisements requires an access token with the extended permission for ads_management |
114 | Invalid user id list |
3001 | Invalid query |
You can't perform this operation on this endpoint.
You may perform a POST request to the following edges from this node:/{user_id}/adaccountgroups
/{user_id}/videos
/{user_id}/live_videos
/{user_id}/photos
/{user_id}/albums
/{user_id}/favorite_requests
/{user_id}/paymentaccountemails
/{user_id}/paymentaccountphones
/{user_id}/notifications
Error | Description |
---|---|
100 | Invalid parameter |
240 | Desktop applications cannot call this function for other users |
/{user_id}
.Name | Description |
---|---|
emoji_color_pref unsigned int32 | emoji color preference. |
firstname string | This person's first name |
label_cohort Object | This person's label cohort |
lastname string | This person's last name |
name string | Used for test accounts only. Name for this account |
password string | Used for test accounts only. Password for this account |
success
: bool, /{page_label_id}
/users
.read_page_mailboxes
manage_pages
publish_pages
pages_show_list
Name | Description |
---|---|
user_ids list<int> | ID of users that the label will be applied to Required |
success
: bool, /{user_id}
.Name | Description |
---|---|
emoji_color_pref unsigned int32 | emoji color preference. |
firstname string | This person's first name |
label_cohort Object | This person's label cohort |
lastname string | This person's last name |
name string | Used for test accounts only. Name for this account |
password string | Used for test accounts only. Password for this account |
success
: bool, /{custom_audience_id}
/users
.ads_management
Name | Description |
---|---|
namespace string | If extern_id provided and namespace specified, will match under specified namespace and update the mapping if necessary and pass permission check |
payload Object | Payload representing users to add |
session Object | Information about the session. Sessions are used when you have a lot of users to upload. For example, if you have 1 million users to upload, you need to split them into at least 100 requests because each request can only take 10k users. Specify the session info so that you can track if the session has finished or not. |
audience_id
: numeric string, session_id
: numeric string, num_received
: int32, num_invalid_entries
: int32, invalid_entry_samples
: Map {/{page_id}
/leadgen_whitelisted_users
.Name | Description |
---|---|
user_id numeric string | ID of the user to be whitelisted for the page. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
240 | Desktop applications cannot call this function for other users |
Delete a test user
/{ad_account_group_id}
/users
.Name | Description |
---|---|
redownload boolean | Allows you to specify that you would like to retrieve all
fields of the set in your response. Default value: |
uid int | ID of the user Required |
success
: bool, success
: bool, account_group
: Struct {account_group_id
: id, name
: string, status
: unsigned int32, users
: List [uid
: id, permissions
: List [role
: integer, accounts
: List [account_id
: string, account_group_id
: id, status
: unsigned int32, name
: string, /{page_label_id}
/users
.Name | Description |
---|---|
user_ids list<int> | ID of users that the label will be unattached from Required |
success
: bool, /{page_id}
/blocked
.manage_pages
publish_pages
Name | Description |
---|---|
asid int | AppScopedUserID to unblock |
uid int | Deprecated. Same as |
user int | List of User or Page IDs to unblock. This or |
success
: bool, /{user_id}
.success
: bool, /{custom_audience_id}
/users
.ads_management