Returns the current user’s incoming friend requests.

This method requires the following permissions: friends:read.

Parameters

offset
integer (non-negative)

Offset into the friend request list for pagination.

count
integer (1..100)

How many requests to return.

By default 20.

extended
boolean

Whether to return the messages specified by the users who sent the friend requests.

By default false.

need_mutual
boolean

Whether to return information about mutual friends for each friend request.

fields
string

Comma-separated list of user profile fields to be returned.

Result

By default, returns a paginated list of user IDs.

If fields are specified, or either of extended or need_mutual is true, returns a paginated list of objects:

user_id
integer (positive)

If no fields are specified, the user identifier.

user
user

If fields are specified, a user object.

message
string

If extended is true, and this friend request was sent with a message, that message.

mutual
object

If need_mutual is true, an object describing the mutual friends with this user.

count
integer (non-negative)

The total number of mutual friends.

users
array of integers

Up to 10 user IDs of mutual friends.

Errors

Global errors may occur when calling this method.