Friendsfriends.get
Returns a list of user IDs or detailed information about a user's friends.
If you use VK user's social graph in your application, please, note section 4.4. of Platform Rules.
This method can be called by a service token. Only public data is returned.
This method can be called with a user token.
Parameters
| user_id | User ID. By default, the current user ID. int (number) |
| order | Sort order:
By default the list is sorted in ascending order of user IDs. string |
| list_id | ID of the friend list returned by the friends.getLists method to be used as the source. This parameter is taken into account only when the user_id parameter is set to the current user ID. This parameter is available only with a user token received in Standalone-app via Implicit Flow. positive number |
| count | Number of friends to return. positive number, default 5000 |
| offset | Offset needed to return a specific subset of friends. positive number |
| fields | Profile fields to return. Sample values: nickname, domain, sex, bdate, city, country, timezone, photo_50, photo_100, photo_200_orig, has_mobile, contacts, education, online, relation, last_seen, status, can_write_private_message, can_see_all_posts, can_post, universities. list of comma-separated words |
| name_case | Case for declension of user name and surname:
string |
| ref | string, maximum length 255 |
Result
If the fields parameter is not used, returns the total results number in count field and an array of IDs (id) of the user's friends.
If the fields parameter is used, returns the total results number in count field and an array of objects describing users in items field.
Returns not more than 5000 friends if fields are used.
If the fields parameter is used, returns the total results number in count field and an array of objects describing users in items field.
Returns not more than 5000 friends if fields are used.
Errors
| 30 | This profile is private |
Linked methods
friends.getRecent
Returns a list of user IDs of the current user's recently added friends.
friends.search
Returns a list of friends matching the search criteria.
friends.getOnline
Returns a list of user IDs of a user's friends who are online.
friends.getRequests
Returns information about the current user's incoming and outgoing friend requests.
friends.areFriends
Checks the current user's friendship status with other specified users.
Version historyShow all
5.8
Fields city and country in fields return object instead of id.