Xsolla-logo

Lire les amis d'un utilisateurClient-side

get/users/me/relationships

Récupère la liste des utilisateurs ajoutés en tant qu'amis de l'utilisateur authentifié.

SecurityBearer or APIKey
Request
query Parameters
type
required
string

Type d'amis. Valeurs possibles :

  • friends : pour obtenir la liste des utilisateurs ajoutés à la liste d'amis.
  • friend_requested : pour obtenir la liste des utilisateurs qui ont reçu une demande d'ami.
  • friend_requested_by : pour obtenir la liste des utilisateurs qui ont envoyé une demande d'ami.
  • blocked : pour obtenir la liste des utilisateurs ajoutés à la liste d'amis, mais bloqués.
  • blocked_by : pour obtenir la liste des utilisateurs qui ont bloqué cet utilisateur.
Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by
required
string

Condition de tri des utilisateurs. Valeurs possibles :

  • by_nickname : pour trier la liste par ordre alphabétique de pseudo.
  • by_updated : pour trier la liste par la date à laquelle les utilisateurs ont récemment ajouté quelqu'un à leur liste d'amis ou l'ont bloqué.
Enum: "by_nickname" "by_updated"
sort_order
required
string

Condition de tri de la liste des utilisateurs. Valeurs possibles :

  • asc : pour appliquer la valeur sort_by dans l'ordre croissant.
  • desc : pour appliquer la valeur sort_by dans l'ordre décroissant.
Enum: "asc" "desc"
after
string

Paramètre utilisé pour la pagination de l'API.

limit
integer [ 1 .. 50 ]
Default: 20

Nombre maximum d'utilisateurs renvoyés à la fois.

Responses
200

OK

400

Bad Request

401

Forbidden

403

Forbidden

404

Not Found

Request samples
Response samples
application/json
{}