- 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
chat.getThreadHistory
GET https://chat.api.rivet.gg/v1/threads/{thread_id}/history
curl -X GET 'https://chat.api.rivet.gg/v1/threads/{thread_id}/history'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
RFC3339 timestamp.
How many messages to collect in each direction. If querying rivet.api.chat.common#QueryDirection$before_and_after, rivet.api.chat.common#QueryDirection$chat_messages will be count * 2.
Represents which direction to query messages from relative to the given timestamp.
Response
Ordered old to new.
If querying rivet.api.chat.common#before_and_after, this will be
count * 2 long.
Represents types of chat message bodies.
An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 Documentation at https://jwt.io/
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 An identity handle.
The URL of this identity's avatar image.
External links for an identity.
A link to a chat page with the given identity.
A link to this identity's profile page.
A link to the Rivet settings page.
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.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party activity denoting that the party is currently in a lobby.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A party lobby.
External links for a party.
A link to the given party's chat thread.
Information about the identity's current status, party, and active game.
The game an identity is currently participating in.
The URL of this game's banner image.
The URL of this game's logo image.
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.
A short activity message about the current game activity.
JSON data seen only by the given identity and their mutual followers.
JSON data seen by anyone.
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 curl -X GET 'https://chat.api.rivet.gg/v1/threads/{thread_id}/history'