API Reference

Friends.getMyFriends

Returns an array of friends for the currently logged-in user along with the users basic user information.


Syntax

array friends.getMyFriends ( INT friendstatus = 3 )

Arguments

NameTypeRequiredDefault valueDescription
friendstatusINTOptional3The frinedship 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).

Response

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

NameTypeDescription
idINTThe ID of the user.
friendstatusINTThe 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).
userSTRINGThe username of the users friend.
websiteSTRINGThe website of the users friend.
firstnameSTRINGThe firstname of the users friend.
lastnameSTRINGThe lastname of the users friend.
nicknameSTRINGThe nickname of the users friend.
countrySTRINGThe 2-letter country code of the users friend.
avatarINTThe ID of the friend's avatar.

Sample Response

Code examples

0 comments

Be the first to comment on getMyFriends.

Add a Comment

  • captcha