Xsolla-logo

Freunde des Benutzers abrufenClient-side

get/users/me/relationships

Ruft eine Liste von Benutzern ab, die der Freundesliste des authentifizierten Benutzers hinzugefügt wurden.

SecurityBearer or APIKey
Request
query Parameters
type
required
string

Freund-Typ. Möglich sind:

  • friends, um die Liste der Benutzer abzurufen, die der Freundesliste hinzugefügt wurden
  • friend_requested, um die Liste der Benutzer abzurufen, die eine Freundschaftsanfrage erhalten haben
  • friend_requested_by, um die Liste der Benutzer abzurufen, die eine Freundschaftsanfrage gesendet haben
  • blocked, um die Liste der Benutzer abzurufen, die auf der Freundesliste stehen, aber geblockt sind
  • blocked_by, um die Liste der Benutzer abzurufen, die diesen Benutzer geblockt haben
Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by
required
string

Sortierbedingungen für die Benutzer. Möglich sind:

  • by_nickname, um die Liste alphabetisch nach dem Nickname zu sortieren
  • by_updated, um die Liste nach dem Datum zu sortieren, an dem die Benutzer der Freundesliste hinzugefügt oder geblockt wurden
Enum: "by_nickname" "by_updated"
sort_order
required
string

Sortierbedingungen für die Benutzerliste. Möglich sind:

  • asc, um den sort_by-Wert in aufsteigender Reihenfolge anzuwenden
  • desc, um den sort_by-Wert in absteigender Reihenfolge anzuwenden
Enum: "asc" "desc"
after
string

Parameter, der für die API-Paginierung verwendet wird.

limit
integer [ 1 .. 50 ]
Default: 20

Maximale Anzahl von Benutzern, die gleichzeitig zurückgegeben werden.

Responses
200

OK

400

Bad Request

401

Forbidden

403

Forbidden

404

Not Found

Request samples
curl --request GET \
  --url 'https://login.xsolla.com/api/users/me/relationships?after=SOME_STRING_VALUE&limit=20&type=SOME_STRING_VALUE&sort_by=SOME_STRING_VALUE&sort_order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer BEARER_TOKEN'
Response samples
application/json
{}