Xsolla-logo

ユーザーの友達を取得する

get/users/me/relationships

認証されたユーザーの友人として追加されたユーザーのリストを取得します。

SecurityBearer
Request
query Parameters
type
required
string

友達のタイプ。以下の値を指定できます:

  • friendsは、友達リストに追加されたユーザーのリストを取得します
  • friend_requestedは、友達リクエストを取得したユーザーのリストを取得します
  • friend_requested_byは、友達リクエストを送信したユーザーのリストを取得します
  • blockedは、友達リストに追加されてブロックされたユーザーのリストを取得します

*blocked_byは、このユーザーをブロックしたユーザーのリストを取得します

Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by
required
string

ユーザーをソートする条件。以下の値を指定できます:

  • by_nicknameは、リストをニックネームのアルファベット順に並べ替えます
  • by_updatedは、ユーザーが最近友達リストに誰かを追加またはブロックした日付でリストを並べ替えます
Enum: "by_nickname" "by_updated"
sort_order
required
string

ユーザーのリストをソートする条件。以下の値を指定できます: *asc は、sort_by値を昇順で適用します *descsort_by値を降順で適用します

Enum: "asc" "desc"
after
string

APIページネーションに使用されるパラメータ。

limit
integer [ 1 .. 50 ]
Default: 20

一度に返されるユーザー数の最大値。

Responses
200

OK

400

無効なリクエスト

403

アクセス拒否

404

見つかりません

Request samples
Response samples
application/json
{}