friends
This endpoint will provide user’s BuddyPress friends. xProfile fields can also be included in response if you include `xprofile` var and provide comma separated BuddyPress xprofile field labels for friends’ additional data.
Friends with xProfile Fields data
http://localhost/api/userplus/friends/? key=KEY=HERE&user_id=1&xprofile=Birthday,City,Address
Resource URL
http://localhost/api/userplus/friends/Method
POST
Required Parameters
- user_id
- key – get API key from Settings > User Plus
Optional Parameters
- xprofile – comma separated BuddyPress xprofile field labels for friends data
Sample Request URL
http://localhost/api/userplus/friends/?key=KEY-HERE&user_id=1&xprofile=City,CountryRelated Endpoints
- friends_accept_friendship
- friends_add_friend
- friends_check_friendship
- friends_count_invitable_friends
- friends_friend_count
- friends_friend_count_for_user
- friends_friend_ids