friends.getMyFriends

Syntax

array friends.getMyFriends ( INT friendstatus = 3, INT uid = 0, INT page = 0, INT pageSize = 25 )

Argument Info

Name	Type	Required	Default value	Description
friendstatus	INT	Optional	3	The friendship status of the friends that you want returned. Possible values are 1, 2 and 3: 1 = friendship is unconfirmed. Friendship was requested from uid1 (waiting on uid2 to confirm the friendship) 2 = friendship is unconfirmed. Friendship was requested from uid2 (waiting on uid1 to confirm the friendship) 3 = confirmed (friendship status is confirmed).
uid	INT	Optional	0	The user ID related to this call if not using loggedinuser info
page	INT	Optional	0	Page number, based off pageSize parameter, default is the first page, page 0.
pageSize	INT	Optional	25	Total records returned per page, default 25

Response

This is the content of the array for each user that will be returned on success of the request.

Name	Type	Description
id	INT	The ID of the user.
friendstatus	INT	The friend status between the logged in user ID and the returned user(s). Possible values are 1, 2 and 3: 1 = friendship is unconfirmed. Friendship was requested from uid1 (waiting on uid2 to confirm the friendship) 2 = friendship not confirmed. Friendship was requested from uid2 (waiting on uid1 to confirm the friendship) 3 = confirmed (friendship status is confirmed).
user	STRING	The username of the users friend.
website	STRING	The website of the users friend.
firstname	STRING	The firstname of the users friend.
lastname	STRING	The lastname of the users friend.
nickname	STRING	The nickname of the users friend.
country	STRING	The 2-letter country code of the users friend.
avatar	INT	The ID of the friend's avatar.

Return Values

Field	Description	Possible Values