friends_listing
This endpoint is used to search the friends of a user by a search string. There are number of optional parameters available to filter friends results. Please see below.
Newest Friends Listing
http://localhost/api/userplus/friends_listing/?key=KEY-HERE&user_id=1&type=newest
Alphabetical Friends Listing
http://localhost/api/userplus/friends_listing/?key=KEY-HERE&user_id=1&type=alphabetical
Pagination Friends Listing
http://localhost/api/userplus/friends_search_friends/?key=KEY-HERE&user_id=1&page=1&per_page=10
Resource URL
http://localhost/api/userplus/friends_listing/Method
POST
Required Parameters
- user_id - ID of the user whose friends are being retrieved.
- key – get API key from Settings > User Plus
Optional Parameters
- type – Possible values- active, newest, alphabetical. Default - active
- per_page - Number of results to return per page. Default: 0 (no pagination; show all results).
- page - Number of the page of results to return. Default: 0 (no pagination; show all results).
- search - The search string, Limit results to those matching a search string.
Sample Request URL
http://localhost/api/userplus/friends_listing/?key=KEY-HERE&user_id=1Related Endpoints
- friends
- friends_accept_friendship
- friends_add_friend
- friends_check_friendship
- friends_count_invitable_friends
- friends_friend_count
- friends_friend_count_for_user