- 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
identity.getProfile
GET https://identity.api.rivet.gg/v1/identities/{identity_id}/profile
curl -X GET 'https://identity.api.rivet.gg/v1/identities/{identity_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
An identity profile.
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.
Whether or not this identity is registered with a linked account.
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.
none, view, join none, view, join none, view, join 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.
Whether or not this party member is the leader of the given party.
A party member state denoting that the member is idle.
A party member state denoting that the member is currently waiting to start matchmaking.
A party member state denoting that the member is currently searching for a lobby.
A party member state denoting that the member is in a lobby.
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.
Whether or not this identity is an admin.
Whether or not this game user has been linked through the Rivet dashboard.
Deprecated
inactive, pending, accepted Whether or not the requestee's identity is following this identity.
Whether or not this identity is both followng and is followed by the requestee's identity.
Follows regex ^(?:[^\n\r]+\n?|\n){1,5}$
An identity's linked email.
A valid email address
A group handle.
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 group.
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 game statistic config.
A value denoting the format method of a game statistic.
integer, float_1, float_2, float_3, duration_minute, duration_second, duration_hundredth_second A value denoting the aggregation method of a game statistic.
sum, average, min, max A value denoting the sorting method of a game statistic.
desc, asc A string appended to the end of a singular game statistic's value. Example: 1 dollar.
A string appended to the end of a game statistic's value that is not exactly 1. Example: 45 dollars.
A string appended to the beginning of a singular game statistic's value. Example: value 1.
A string prepended to the beginning of a game statistic's value that is not exactly 1. Example: values 45.
A single overall value of the given statistic.
Whether or not this identity is awaiting account deletion. Only visible to when the requestee is this identity.
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://identity.api.rivet.gg/v1/identities/{identity_id}/profile'