get-group-profile

GetGroupProfile

Returns a group profile.

Path Parameters

group_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.

Query Parameters

watch_index string
A query parameter denoting the requests watch index.

Responses

GetGroupProfile 200 response

Schema

group object required
A list of group profiles.
group_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
display_name string required
Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
Represent a resource's readable display name.
avatar_url string
The URL of this group's avatar image.
external object required
External links for this group.
profile string required
A link to this group's profile page.
chat string required
A link to this group's chat page.
is_developer boolean required
Whether or not this group is a developer.
bio string required
Possible values: 1 ≤ length ≤ 200, Value must match regular expression ^[^\r]+$
Detailed information about a profile.
is_current_identity_member boolean required
Whether or not the current identity is a member of this group.
publicity string required
Possible values: [open, closed]
The current publicity value for the given group.
member_count int32 required
Unsigned 32 bit integer.
members object[] required
A list of group members.
identity object required
An identity handle.
identity_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
display_name string required
Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
Represent a resource's readable display name.
account_number int32 required
Possible values: value ≤ 9999
Identity profile account number (#1234).

These are assigned in addition to an identity's display name in order to allow multiple identities to have the same display name while still providing a unique handle.

These are unique to each display name; you can have multiple accounts with different display names and the same account number.
avatar_url string required
The URL of this identity's avatar image.
presence object
Information about the identity's current status, party, and active game.
update_ts date-time required
RFC3339 timestamp.
status string required
Possible values: [online, away, offline]
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
game_activity object
The game an identity is currently participating in.
game object required
A game handle.
game_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
name_id string required
Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$
A human readable short identifier used to references resources.

Different than a rivet.common#Uuid because this is intended to be human readable.

Different than rivet.common#DisplayName because this should not include special characters and be short.
display_name string required
Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
Represent a resource's readable display name.
logo_url string
The URL of this game's logo image.
banner_url string
The URL of this game's banner image.
message string required
A short activity message about the current game activity.
public_metadata
JSON data seen by anyone.
mutual_metadata
JSON data seen only by the given identity and their mutual followers.
party object
A party handle.
party_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
create_ts date-time required
RFC3339 timestamp.
activity required
A union representing the activity of a given party.
external object required
External links for a party.
chat string required
A link to the given party's chat thread.
is_registered boolean required
Whether or not this identity is registered with a linked account.
external object required
External links for an identity.
profile string required
A link to this identity's profile page.
settings string
A link to the Rivet settings page.
chat string
A link to a chat page with the given identity.
join_requests object[] required
A list of group join requests.
identity object required
An identity handle.
identity_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
display_name string required
Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
Represent a resource's readable display name.
account_number int32 required
Possible values: value ≤ 9999
Identity profile account number (#1234).

These are assigned in addition to an identity's display name in order to allow multiple identities to have the same display name while still providing a unique handle.

These are unique to each display name; you can have multiple accounts with different display names and the same account number.
avatar_url string required
The URL of this identity's avatar image.
presence object
Information about the identity's current status, party, and active game.
update_ts date-time required
RFC3339 timestamp.
status string required
Possible values: [online, away, offline]
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
game_activity object
The game an identity is currently participating in.
game object required
A game handle.
game_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
name_id string required
Possible values: 1 ≤ length ≤ 16, Value must match regular expression ^[a-zA-Z0-9](?:[a-zA-Z0-9]-?)+[a-zA-Z0-9]$
A human readable short identifier used to references resources.

Different than a rivet.common#Uuid because this is intended to be human readable.

Different than rivet.common#DisplayName because this should not include special characters and be short.
display_name string required
Possible values: 1 ≤ length ≤ 24, Value must match regular expression ^(?:[^ \n\r] ?)+[^ \n\r]$
Represent a resource's readable display name.
logo_url string
The URL of this game's logo image.
banner_url string
The URL of this game's banner image.
message string required
A short activity message about the current game activity.
public_metadata
JSON data seen by anyone.
mutual_metadata
JSON data seen only by the given identity and their mutual followers.
party object
A party handle.
party_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
create_ts date-time required
RFC3339 timestamp.
activity required
A union representing the activity of a given party.
external object required
External links for a party.
chat string required
A link to the given party's chat thread.
is_registered boolean required
Whether or not this identity is registered with a linked account.
external object required
External links for an identity.
profile string required
A link to this identity's profile page.
settings string
A link to the Rivet settings page.
chat string
A link to a chat page with the given identity.
ts date-time required
RFC3339 timestamp.
is_current_identity_requesting_join boolean required
Whether or not the current identity is currently requesting to join this group.
owner_identity_id string required
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
thread_id string
Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
A universally unique identifier.
watch object required
Provided by watchable endpoints used in blocking loops.
index string required
Index indicating the version of the data responded.

Pas this to rivet.common#WatchQuery to block and wait for the next response.

GetGroupProfile​

GetGroupProfile