Xsolla-logo

Get user’s friends

get/users/me/relationships

Gets a list of users added as friends of the authenticated user.

SecurityBearer
Request
query Parameters
type
required
string

Friends type. Can be:

  • friends to get the list of the users added to the friend list
  • friend_requested to get the list of the users to who got the friend request
  • friend_requested_by to get the list of the users from who sent a friend request
  • blocked to get the list of the users added to the friend list, but blocked
  • blocked_by to get the list of the users who blocked this user
Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by
required
string

Condition for sorting the users. Can be:

  • by_nickname to sort the list alphabetically by the nickname
  • by_updated to sort the list by the date when users recently added someone to their friend list or blocked them
Enum: "by_nickname" "by_updated"
sort_order
required
string

Condition for sorting the list of users. Can be:

  • asc to apply the sort_by value in ascending order
  • desc to apply the sort_by value in descending order
Enum: "asc" "desc"
after
string

Parameter that is used for API pagination.

limit
integer [ 1 .. 50 ]
Default: 20

Maximum number of users that are returned at a time.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

Request samples
curl -i -X GET \
  'https://login.xsolla.com/api/users/me/relationships?type=friends&sort_by=by_nickname&sort_order=asc&after=string&limit=20' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{}