Skip to content
RallyHere Docs
GitHub

Get Friends List For Player

Deprecated
GET
/friends/v1/player/{player_id}/friend

Fetch the friend’s list for the Player and their relationship status with those friends.

Note: This API supports etags and will return the etag header when with the response. Clients and then utilize the if-none-match header to avoid having to reload the response if it has not changed.

Permissions Required: friend:friend_list:read

Authorizations

  • HTTPBearerHeadersOrCookie

Parameters

Path Parameters

player_id
required
integer

Query Parameters

page
integer
limit
integer
default: 50 >= 1 <= 10000

Header Parameters

if-none-match

If you provide the ETag that matches the current ETag for this resource, a 304 response will be return - indicating that the resource has not changed.

string

If you provide the ETag that matches the current ETag for this resource, a 304 response will be return - indicating that the resource has not changed.

Responses

200

Successful Response

List of the player’s friends. Includes sent friend requests and received friends requests.

object
player_uuid
required
string format: uuid
player_id
required
integer
friends
required
Array<object>

Represents the relationship with a potential friend. V1 includes player_id and player_uuid.

object
friends_player_uuid
required
string format: uuid
friends_player_id
integer
status
required
string
Allowed values: NONE FRIENDS FRIEND_REQUEST_SENT FRIEND_REQUEST_PENDING FRIEND_REQUEST_DECLINED_BY_OTHER
notes
string
last_modified_on
required
string format: date-time
page
required
object
page
required
integer
limit
required
integer
total
required
integer

Headers

ETag
string

Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

304

Content still has the same etag and has not changed

400

Bad Request

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

403

Forbidden

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

409

Conflict

object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string