Graph API Version

User Invitable Friends

Reading

This edge is only available to Games (including PC Gaming platform - Arcade), and requires the user_friends permission.

Graph API Explorer
GET /v2.7/{user-id}/invitable_friends HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{user-id}/invitable_friends'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{user-id}/invitable_friends",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{user-id}/invitable_friends",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{user-id}/invitable_friends"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

Permissions

Developers usually request these permissions for this endpoint:
  • user_friends

Parameters

NameDescription
excluded_ids
list<invite token>

Invite Tokens of the users to exclude

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {} }

data

A list of UserInvitableFriend nodes.

paging

For more details about pagination, see the Graph API guide.

Validation Rules

ErrorDescription
110Invalid user id
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.