- Overview
- Matchmaker
- Serverless Lobbies
- CDN
- Identity
- KV
- Cloud
- Identity
- GET⭐️ identity.events.watch
- POST⭐️ identity.links.prepare
- POST⭐️ identity.setup
- GETidentity.links.get
- GETgroup.listSuggested
- POSTgroup.create
- POSTgroup.prepareAvatarUpload
- POSTgroup.validateProfile
- GETgroup.search
- POSTgroup.completeAvatarUpload
- GETgroup.getBans
- DELgroup.unbanIdentity
- POSTgroup.banIdentity
- POSTgroup.invites.createInvite
- POSTgroup.joinRequests.resolveJoinRequest
- POSTgroup.joinRequests.resolveJoinRequest
- GETgroup.getJoinRequests
- POSTgroup.kickMember
- POSTgroup.leave
- GETgroup.getMembers
- GETgroup.getProfile
- POSTgroup.updateProfile
- GETgroup.getSummary
- POSTgroup.transferOwnership
- POSTidentity.prepareAvatarUpload
- POSTidentity.completeAvatarUpload
- GETidentity.getHandles
- GETidentity.getSummaries
- POSTidentity.updateStatus
- GETidentity.search
- DELidentity.removeGameActivity
- POSTidentity.setGameActivity
- POSTidentity.signupForBeta
- DELidentity.unmarkDeletion
- POSTidentity.markDeletion
- GETidentity.listFriends
- GETidentity.getSelfProfile
- POSTidentity.updateProfile
- POSTidentity.validateProfile
- GETidentity.listRecentFollowers
- POSTidentity.ignoreRecentFollower
- DELidentity.unfollow
- POSTidentity.follow
- GETidentity.listFollowers
- GETidentity.listFollowing
- GETidentity.listMutualFriends
- GETidentity.getProfile
- POSTidentity.report
- GETchat.identity.getDirectThread
- GETgroup.invites.getInvite
- POSTgroup.invites.consumeInvite
- POSTchat.sendMessage
- GETchat.getThreadHistory
- GETchat.watchThread
- POSTchat.setThreadRead
- GETchat.getThreadTopic
- PUTchat.setTypingStatus
Overview
API
group.getProfile
GET https://group.api.rivet.gg/v1/groups/{group_id}/profile
curl -X GET 'https://group.api.rivet.gg/v1/groups/{group_id}/profile'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
A query parameter denoting the requests watch index.
Response
A list of group profiles.
Represent a resource's readable display name.
The URL of this group's avatar image.
External links for this group.
A link to this group's profile page.
A link to this group's chat page.
Whether or not this group is a developer.
Detailed information about a profile.
Whether or not the current identity is a member of this group.
The current publicity value for the given group.
open, closed Unsigned 32 bit integer.
A list of group members.
An identity handle.
The URL of this identity's avatar image.
Information about the identity's current status, party, and active game.
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
online, away, offline The game an identity is currently participating in.
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.
The URL of this game's logo image.
The URL of this game's banner image.
A short activity message about the current game activity.
JSON data seen by anyone.
JSON data seen only by the given identity and their mutual followers.
A union representing the activity of a given party.
A party activity denoting that the party is idle.
A party activity denoting that the party is currently searching for a lobby.
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.
The URL of this game's logo image.
The URL of this game's banner image.
A party activity denoting that the party is currently in a lobby.
A party lobby.
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.
The URL of this game's logo image.
The URL of this game's banner image.
External links for a party.
A link to the given party's chat thread.
Whether or not this identity is registered with a linked account.
External links for an identity.
A link to this identity's profile page.
A link to the Rivet settings page.
A link to a chat page with the given identity.
A list of group join requests.
An identity handle.
The URL of this identity's avatar image.
Information about the identity's current status, party, and active game.
The current status of an identity. This helps players understand if another player is currently playing or has their game in the background.
online, away, offline The game an identity is currently participating in.
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.
The URL of this game's logo image.
The URL of this game's banner image.
A short activity message about the current game activity.
JSON data seen by anyone.
JSON data seen only by the given identity and their mutual followers.
A union representing the activity of a given party.
A party activity denoting that the party is idle.
A party activity denoting that the party is currently searching for a lobby.
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.
The URL of this game's logo image.
The URL of this game's banner image.
A party activity denoting that the party is currently in a lobby.
A party lobby.
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.
The URL of this game's logo image.
The URL of this game's banner image.
External links for a party.
A link to the given party's chat thread.
Whether or not this identity is registered with a linked account.
External links for an identity.
A link to this identity's profile page.
A link to the Rivet settings page.
A link to a chat page with the given identity.
RFC3339 timestamp.
Whether or not the current identity is currently requesting to join this group.
Provided by watchable endpoints used in blocking loops.
Index indicating the version of the data responded.
Pass this to WatchQuery to block and wait for the next response.
curl -X GET 'https://group.api.rivet.gg/v1/groups/{group_id}/profile'