Obter amigos do usuário

Obter amigos do usuárioClient-side

get/users/me/relationships

Obtém uma lista de usuários adicionados como amigos do usuário autenticado.

SecurityBearer or APIKey

Request

query Parameters

type required	string Tipo de amigos. Pode ser: `friends` para obter a lista dos usuários adicionados à lista de amigos `friend_requested` para obter a lista dos usuários que receberam o pedido de amizade `friend_requested_by` para obter a lista dos usuários que enviaram um pedido de amizade `blocked` para obter a lista dos usuários adicionados à lista de amigos, mas bloqueados `blocked_by` para obter a lista dos usuários que bloquearam este usuário Enum: "friends" "friend_requested" "friend_requested_by" "blocked" "blocked_by"
sort_by required	string Condição para classificar os usuários. Pode ser: `by_nickname` para classificar a lista em ordem alfabética pelo apelido `by_updated` para classificar a lista pela data em que os usuários adicionaram alguém recentemente à sua lista de amigos ou os bloquearam Enum: "by_nickname" "by_updated"
sort_order required	string Condição para classificar a lista de usuários. Pode ser: `asc` para aplicar o valor `sort_by` em ordem crescente `desc` para aplicar o valor `sort_by` em ordem decrescente Enum: "asc" "desc"
after	string Parâmetro usado para paginação de API.
limit	integer [ 1 .. 50 ] Default: 20 Número máximo de usuários retornados por vez.

Responses

200

400

Pedido incorreto

401

Proibido

403

Proibido

404

Não 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

{"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": "",
"tag": "423432"
}
},
{"status_incoming": "none",
"status_outgoing": "friend_requested",
"updated": 1494499213.4718,
"user": {"id": "user-2",
"name": "name-2",
"nickname": "nick-2",
"picture": "",
"tag": "3100"
}
}
]
}
]
}