friends_search_friends
This endpoint is used to search the friends of a user by a search string.
Example: Search User Friends with pagination
http://localhost/api/userplus/friends_search_friends/?key=KEY-HERE&user_id=1&search=john
Resource URL
http://localhost/api/userplus/friends_search_friends/Method
POST
Required Parameters
- user_id - ID of the user whose friends are being searched.
- search - The search string, matched against xprofile fields (if available), or usermeta 'nickname' field.
- key – get API key from Settings > User Plus
Optional Parameters
- per_page - Max number of friends to return. Default : 10
- page - The page of results to return. Default: null (no pagination - return all results).
Sample Request URL
http://localhost/api/userplus/friends_search_friends/?key=KEY-HERE&user_id=1&search=johnRelated Endpoints
- friends
- friends_accept_friendship
- friends_add_friend
- friends_check_friendship
- friends_count_invitable_friends
- friends_friend_count
- friends_friend_count_for_user