Get user’s friends

get/users/me/relationships

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

SecurityBearer or APIKey

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

400

Bad Request

401

Forbidden

403

Forbidden

404

Not Found

Request samples

Response samples

application/json

{"next_after": "string",
"next_url": "string",
"relationships": [{"next_after": "bmFtZS0ydXNlci0y",
"next_url": "https://login.xsolla.com/api/users/by_access_key/access-key-1/relationships?type=friend_requests&sort_by=by_name&limit=2&after=bmFtZS0ydXNlci0y",
"relationships": [{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499214.3501,
"user": {"id": "user-3",
"name": "name-3",
"nickname": "nick-2",
"picture": "",
"presence": "offline",
"tag": "423432"
}
},
{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499213.4718,
"user": {"id": "user-2",
"name": "name-2",
"nickname": "nick-2",
"picture": "",
"presence": "offline",
"tag": "3100"
}
}
]
}
]
}