listFriends
Description
Coming Soon!
Code Examples
Request
curl -X GET 'https://api.rivet.gg/identity/identities/self/friends'
Request Parameters
anchor
Query parameter, optional
limit
Query parameter, optional
Range is between 1 and 32 (inclusive).
Response Body
anchor
string
identities
array<object> (required)
identities[*].account_number
integer (required)
identities[*].avatar_url
string (required)
The URL of this identity's avatar image.
identities[*].display_name
string (required)
identities[*].external
object (required)
External links for an identity.
identities[*].external.profile
string (required)
A link to this identity's profile page.
identities[*].external.settings
string
A link to the Rivet settings page.
identities[*].identity_id
string (required)
identities[*].is_registered
boolean (required)
Whether or not this identity is registered with a linked account.
identities[*].presence
object
Information about the identity's current status, party, and active game.
identities[*].presence.game_activity
object
The game an identity is currently participating in.
identities[*].presence.game_activity.game
object (required)
identities[*].presence.game_activity.game.banner_url
string
The URL of this game's banner image.
identities[*].presence.game_activity.game.display_name
string (required)
identities[*].presence.game_activity.game.game_id
string (required)
identities[*].presence.game_activity.game.logo_url
string
The URL of this game's logo image.
identities[*].presence.game_activity.game.name_id
string (required)
A human readable short identifier used to references resources. Different than a uuid because this is intended to be human readable. Different than DisplayName because this should not include special characters and be short.
identities[*].presence.game_activity.message
string (required)
A short activity message about the current game activity.
identities[*].presence.game_activity.mutual_metadata
object
JSON data seen only by the given identity and their mutual followers.
identities[*].presence.game_activity.public_metadata
object
JSON data seen by anyone.
identities[*].presence.status
string (required)
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
identities[*].presence.update_ts
string (required)
watch
object (required)
Provided by watchable endpoints used in blocking loops.
watch.index
string (required)
Index indicating the version of the data responded.
Pass this to WatchQuery to block and wait for the next response.