- 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.search
GET https://identity.api.rivet.gg/v1/identities/search
curl -X GET 'https://identity.api.rivet.gg/v1/identities/search'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The query to match identity display names and account numbers against.
How many identities to offset the search by.
Amount of identities to return. Must be between 1 and 32 inclusive.
Response
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.
The pagination anchor.
curl -X GET 'https://identity.api.rivet.gg/v1/identities/search'