Xsolla-logo

Obtener los amigos del usuarioClient-side

get/users/me/relationships

Obtiene una lista de usuarios añadidos como amigos del usuario autenticado.

SecurityBearer or APIKey
Request
query Parameters
type
required
string

Tipo de amigos. Puede ser:

  • friends para obtener la lista de los usuarios añadidos a la lista de amigos
  • friend_requested para obtener la lista de los usuarios a los que se envió solicitud de amistad
  • friend_requested_by para obtener la lista de los usuarios que enviaron una solicitud de amistad
  • blocked para obtener la lista de los usuarios añadidos a la lista de amigos, pero bloqueados
  • blocked_by para obtener la lista de los usuarios que bloquearon a este usuario.
Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by
required
string

Condición para ordenar a los usuarios. Puede ser:

  • by_nickname para ordenar la lista alfabéticamente por el alias
  • by_updated para ordenar la lista por la fecha en que los usuarios añadieron recientemente a alguien a su lista de amigos o le bloquearon.
Enum: "by_nickname" "by_updated"
sort_order
required
string

Condición para ordenar la lista de usuarios. Puede ser:

  • asc para aplicar el valor sort_by en orden ascendente
  • desc para aplicar el valor sort_by en orden descendente.
Enum: "asc" "desc"
after
string

Parámetro que se utiliza para la paginación de la API.

limit
integer [ 1 .. 50 ]
Default: 20

Número máximo de usuarios que se devuelven simultáneamente.

Responses
200

ACEPTAR

400

Bad Request (Solicitud errónea)

401

Forbidden (Prohibido)

403

Forbidden (Prohibido)

404

Not Found (No encontrado)

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
{}