Returns information about friendship states and friend requests related to the specified users.

This method requires the following permissions: friends:read.

Parameters

user_ids
string

Comma-separated list of user identifiers to retrieve friendship states for.

extended
boolean

Whether to return is_request_unread.

Result

An array of objects:

user_id
integer (positive)

User identifier.

friend_status
enum

The relationship between this user and the current user.

  • follow_requested – Only for remote users – current user tried to follow this user, but their server hasn’t yet accepted that request
  • followed_by – This user is following the current user
  • following – Current user is following this user
  • friends – Users are friends (they follow each other)
  • none – No relationship
is_request_unread
boolean

Whether there’s an incoming friend request from this user. Only returned when extended is true and friend_status is followed_by.

Errors

Global errors may occur when calling this method.