Matrix Client-Server OpenID API

Get an OpenID token object to verify the requester's identity.

Client Authenication

Matrix Client-Server Room Knocking API

Knock on a room, requesting permission to join.

Matrix Client-Server filter API

user/{user Id}/filter

Upload a new filter.Download a filter

Matrix Client-Server Cross Signing API

Upload cross-signing keys.Upload cross-signing signatures.

Matrix Identity Service Authentication API

Gets account holder information for a given token.Exchanges an OpenID token for an access token.Logs out an access token, rendering it unusable.

Matrix Client-Server Third Party Lookup API

thirdparty-location

Reverse-lookup third party locations given a Matrix room alias.Retrieve Matrix-side portals rooms leading to a third party location.

thirdparty-user

Reverse-lookup third party users given a Matrix User ID.Retrieve the Matrix User ID of a corresponding third party user.

Retrieve metadata about all protocols that a homeserver supports.Retrieve metadata about a specific protocol that the homeserver supports.

Matrix Federation User Device Management API

Gets all of the user's devices

Matrix Client-Server message event send API

Send a message event to the given room.

Matrix Client-Server Account Administrative Contact API

Gets a list of a user's third party identifiers.Adds contact information to the user's account.Adds contact information to the user's account.Binds a 3PID to the user's account through an Identity Service.Deletes a third party identifier from the user's account Removes a user's third party identifier from an identity server.Begins the validation process for an email address for association with the user's account.Begins the validation process for a phone number for association with the user's account.

Matrix Identity Service Email Associations API

validate/email-submit Token

Validate ownership of an email address.Validate ownership of an email address.

Request a token for validating an email address.

Matrix Federation Version API

Get the implementation name and version of this homeserver.

Matrix Client-Server Content Repository API

download/{server Name}/{media Id}

Download content from the content repository.Download content from the content repository overriding the file name

Upload some content to the content repository.Download a thumbnail of content from the content repository Get information about a URL for a client Get the configuration for the content repository.

Matrix Client-Server Registration and Login API

Get the supported login types to authenticate users Authenticates the user.

Invalidates a user access token Invalidates all access tokens for a user

Matrix Identity Service Ephemeral Invitation Signing API

Sign invitation details

Matrix Federation Knock Room API

Get information required to make a knock event for a room.Submit a signed knock event to a resident server.

Matrix Federation Public Rooms API

Get all the public rooms for a homeserver Gets the public rooms on the server with optional filter.

Matrix Client-Server Room Upgrades API

Upgrades a room to a new room version.

Matrix Client-Server Registration Token API

Query if a given registration token is still valid.

Matrix Client-Server sync API

Synchronise the client's state and receive new messages.

Matrix Federation Invite User To Room API

Invites a remote user to a room

Matrix Client-Server SSO Login API

login/sso/redirect

Redirect the user's browser to the SSO interface.Redirect the user's browser to the SSO interface for an IdP.

Matrix Client-Server Application Service Room Directory API

Updates a room's visibility in the application service's room directory.

Matrix Client-Server device management API

devices-{device Id}

Get a single device Update a device Delete a device

List registered devices for the current user

Bulk deletion of devices

Matrix Client-Server Typing API

Informs the server that the user has started or stopped typing.

Matrix Client-Server Push Rules API

pushrules-{scope}/{kind}/{rule Id}-enabled

Get whether a push rule is enabled Enable or disable a push rule.

pushrules-{scope}/{kind}/{rule Id}-actions

The actions for a push rule Set the actions for a push rule.

pushrules-{scope}/{kind}/{rule Id}

Retrieve a push rule.Delete a push rule.Add or change a push rule.

Retrieve all push rulesets.

Matrix Identity Service Store Invitations API

Store pending invitations to a user's 3pid.

Matrix Client-Server Rooms API

rooms/{room Id}-state

Get all state events in the current state of a room.Get the state identified by the type and key.

rooms/{room Id}

Get a single event by event ID.Get the m.room.member events for the room.Gets the list of currently joined users and their profile data.

Snapshot the current state of a room and its most recent messages.Get a list of events for this room

Matrix Client-Server Report Content API

Reports an event as inappropriate.

Matrix Client-Server Room Listing API

Lists the user's current rooms.

Matrix Federation Key Exchange API

Query for several server's keys Query for another server's keys

Get the homeserver's public key(s)

Matrix Client-Server Key Backup API

room keys-version-{version}

Get information about an existing backup.Update information about an existing backup.Delete an existing key backup.

room keys-version

Create a new backup.Get information about the latest backup version.

room keys-keys-{room Id}-{session Id}

Store a key in the backup.Retrieve a key from the backup.Delete a key from the backup.

room keys-keys-{room Id}

Store several keys in the backup for a given room.Retrieve the keys from the backup for a given room.Delete the keys from the backup for a given room.

Store several keys in the backup.Retrieve the keys from the backup.Delete the keys from the backup.

Matrix Client-Server Event Context API

Get events and state around the specified event.

Matrix Client-Server Registration API

Register for an account on this homeserver.Begins the validation process for an email to be used during registration.Requests a validation token be sent to the given phone number for the purpose of registering an account Checks to see if a username is available on the server.

account-password

Changes a user's password.Requests a validation token be sent to the given email address for the purpose of resetting a user's password Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.

Deactivate a user's account.

Matrix Client-Server Push API

Gets the current pushers for the authenticated user Modify a pusher for this user on the homeserver.

Matrix Client-Server Sync Guest API

Listen on the event stream of a particular room.

Matrix Client-Server Notifications API

Gets a list of events that the user has been notified about

Matrix Federation Event Authorization API

Get the auth chain for a given event

Matrix Federation Query API

Query for information Query for the room ID and resident homeservers for a room alias Query for profile information about a given user

Matrix Federation Join Room API

Submit a signed join event to a resident server Get information required to make a join event for a room

Matrix Client-Server message redaction API

Strips all non-integrity-critical information out of an event.

Matrix Client-Server Room Directory API

directory/list/room/{room Id}

Gets the visibility of a room in the directory Sets the visibility of a room in the room directory

Lists the public rooms on the server.Lists the public rooms on the server with optional filter.

Matrix Federation Space Hierarchy API

Retrieve a portion of a space tree.

Matrix Client-Server Administration API

Gets information about a particular user.

Matrix Client-Server User Directory API

Searches the user directory.

Matrix Application Service API

thirdparty-user

Reverse-lookup third party users given a Matrix User ID.Retrieve the Matrix User ID of a corresponding third party user.

thirdparty-location

Reverse-lookup third party locations given a Matrix room alias.Retrieve Matrix-side portal rooms leading to a third party location.

Retrieve metadata about a specific protocol that the application service supports.

Send some events to the application service.Query if a user should exist on the application service.Query if a room alias should exist on the application service.

Matrix Client-Server Directory API

directory/room/{room Alias}

Create a new mapping from room alias to room ID.Get the room ID corresponding to this room alias.Remove a mapping of room alias to room ID.

Get a list of local aliases on a given room.

Matrix Federation Transaction API

Send a transaction

Matrix Identity Service Lookup API

Gets hash function information from the server.Look up Matrix User IDs for a set of 3PIDs.

Matrix Federation Leave Room API

Get information required to make a leave event for a room Submit a signed leave event to a resident server

Matrix Federation OpenID API

Exchange an OpenID token for user information

Matrix Federation Server Discovery API

Gets information about the delegated server for server-server communication.

Matrix Identity Service Ping API

Checks that an identity server is available at this API endpoint.

Matrix Client-Server Versions API

Gets the versions of the specification supported by the server.

Matrix Client-Server Profile API

profile/{user Id}-displayname

Set the user's display name.Get the user's display name.

profile/{user Id}-avatar url

Set the user's avatar URL.Get the user's avatar URL.

profile/{user Id}

Get this user's profile information.

Matrix Client-Server Room Creation API

Create a new room

Matrix Federation User Key Management API

Claims one-time encryption keys for a user.Download device identity keys.

Matrix Identity Service Phone Number Associations API

validate/msisdn-submit Token

Validate ownership of a phone number.Validate ownership of a phone number.

validate/msisdn

Request a token for validating a phone number.

Matrix Client-Server Receipts API

Send a receipt for the given event ID.

Matrix Client-Server Account Identification API

Gets information about the owner of an access token.

Matrix Client-Server Client Config API

Upload end-to-end encryption keys.Download device identity keys.Claim one-time encryption keys.Query users with recent device key updates.

user/{user Id}-account data/{type}

Set some account_data for the user.Get some account_data for the user.

user/{user Id}-rooms/{room Id}/account data/{type}

Set some account_data for the user.Get some account_data for the user.

Matrix Client-Server Room Leaving API

rooms/{room Id}

Stop the requesting user participating in a particular room.Stop the requesting user remembering about a particular room.

Matrix Client-Server Presence API

presence/{user Id}/status

Update this user's presence state.Get this user's presence state.

Matrix Client-Server Server Discovery API

Gets Matrix server discovery information about the domain.

Matrix Client-Server Read Marker API

Set the position of the read marker for a room.

Matrix Identity Service Terms of Service API

Gets the terms of service offered by the server.Indicates acceptance of terms to the server.

Matrix Client-Server Room Joining API

Invite a user to participate in a particular room.

Matrix Client-Server Space Hierarchy API

Retrieve a portion of a space tree.

Matrix Client-Server Voice over IP API

Obtain TURN server credentials.

Matrix Client-Server Room Banning API

rooms/{room Id}

Ban a user in the room.Unban a user from the room.

Matrix Client-Server state event send API

Send a state event to the given room.

Matrix Identity Service Versions API

Gets the versions of the specification supported by the server.

Matrix Identity Service Establishing Associations API

Check whether ownership of a 3pid was validated.Publish an association between a session and a Matrix user ID.Remove an association between a session and a Matrix user ID.

Matrix Identity Service Public Key API

Get a public key.Check whether a long-term public key is valid.Check whether a short-term public key is valid.

Matrix Client-Server Room Kicking API

Kick a user from the room.

Matrix Client-Server tag API

user/{user Id}/rooms/{room Id}/tags-{tag}

Add a tag to a room.Remove a tag from the room.

user/{user Id}/rooms/{room Id}/tags

List the tags for a room.

Matrix Client-Server Room Inviting API

Start the requesting user participating in a particular room.Start the requesting user participating in a particular room.

Matrix Client-Server Sync API

Listen on the event stream.Get a single event by event ID.

Get the user's current state.

Matrix Federation Third Party Invites API

Request a server to auth a third party invite event Notifies the server that a third party identifier has been bound to one of its users.

Matrix Client-Server Capabilities API

Gets information about the server's capabilities.

Matrix Client-Server Send-to-device API

Send an event to a given set of devices.

Matrix Client-Server Search API

Perform a server-side search.

Matrix Client-Server Room Membership API for third party identifiers

Invite a user to participate in a particular room.

Matrix Federation Events API

Get all the state of a given room Get all the state event IDs of a given room Get a single event Retrieves the events which precede the given event Retrieves events that the sender is missing

Matrix Push Notification API

Notify a push gateway about an event.

Matrix Client-Server OpenID API

Get an OpenID token object to verify the requester's identity.

Client Authenication

Matrix Client-Server Room Knocking API

Knock on a room, requesting permission to join.

Matrix Client-Server filter API

user/{user Id}/filter

Upload a new filter.Download a filter

Matrix Client-Server Cross Signing API

Upload cross-signing keys.Upload cross-signing signatures.

Matrix Identity Service Authentication API

Gets account holder information for a given token.Exchanges an OpenID token for an access token.Logs out an access token, rendering it unusable.

Matrix Client-Server Third Party Lookup API

thirdparty-location

Reverse-lookup third party locations given a Matrix room alias.Retrieve Matrix-side portals rooms leading to a third party location.

thirdparty-user

Reverse-lookup third party users given a Matrix User ID.Retrieve the Matrix User ID of a corresponding third party user.

Retrieve metadata about all protocols that a homeserver supports.Retrieve metadata about a specific protocol that the homeserver supports.

Matrix Federation User Device Management API

Gets all of the user's devices

Matrix Client-Server message event send API

Send a message event to the given room.

Matrix Client-Server Account Administrative Contact API

Gets a list of a user's third party identifiers.Adds contact information to the user's account.Adds contact information to the user's account.Binds a 3PID to the user's account through an Identity Service.Deletes a third party identifier from the user's account Removes a user's third party identifier from an identity server.Begins the validation process for an email address for association with the user's account.Begins the validation process for a phone number for association with the user's account.

Matrix Identity Service Email Associations API

validate/email-submit Token

Validate ownership of an email address.Validate ownership of an email address.

Request a token for validating an email address.

Matrix Federation Version API

Get the implementation name and version of this homeserver.

Matrix Client-Server Content Repository API

download/{server Name}/{media Id}

Download content from the content repository.Download content from the content repository overriding the file name

Upload some content to the content repository.Download a thumbnail of content from the content repository Get information about a URL for a client Get the configuration for the content repository.

Matrix Client-Server Registration and Login API

Get the supported login types to authenticate users Authenticates the user.

Invalidates a user access token Invalidates all access tokens for a user

Matrix Identity Service Ephemeral Invitation Signing API

Sign invitation details

Matrix Federation Knock Room API

Get information required to make a knock event for a room.Submit a signed knock event to a resident server.

Matrix Federation Public Rooms API

Get all the public rooms for a homeserver Gets the public rooms on the server with optional filter.

Matrix Client-Server Room Upgrades API

Upgrades a room to a new room version.

Matrix Client-Server Registration Token API

Query if a given registration token is still valid.

Matrix Client-Server sync API

Synchronise the client's state and receive new messages.

Matrix Federation Invite User To Room API

Invites a remote user to a room

Matrix Client-Server SSO Login API

login/sso/redirect

Redirect the user's browser to the SSO interface.Redirect the user's browser to the SSO interface for an IdP.

Matrix Client-Server Application Service Room Directory API

Updates a room's visibility in the application service's room directory.

Matrix Client-Server device management API

devices-{device Id}

Get a single device Update a device Delete a device

List registered devices for the current user

Bulk deletion of devices

Matrix Client-Server Typing API

Informs the server that the user has started or stopped typing.

Matrix Client-Server Push Rules API

pushrules-{scope}/{kind}/{rule Id}-enabled

Get whether a push rule is enabled Enable or disable a push rule.

pushrules-{scope}/{kind}/{rule Id}-actions

The actions for a push rule Set the actions for a push rule.

pushrules-{scope}/{kind}/{rule Id}

Retrieve a push rule.Delete a push rule.Add or change a push rule.

Retrieve all push rulesets.

Matrix Identity Service Store Invitations API

Store pending invitations to a user's 3pid.

Matrix Client-Server Rooms API

rooms/{room Id}-state

Get all state events in the current state of a room.Get the state identified by the type and key.

rooms/{room Id}

Get a single event by event ID.Get the m.room.member events for the room.Gets the list of currently joined users and their profile data.

Snapshot the current state of a room and its most recent messages.Get a list of events for this room

Matrix Client-Server Report Content API

Reports an event as inappropriate.

Matrix Client-Server Room Listing API

Lists the user's current rooms.

Matrix Federation Key Exchange API

Query for several server's keys Query for another server's keys

Get the homeserver's public key(s)

Matrix Client-Server Key Backup API

room keys-version-{version}

Get information about an existing backup.Update information about an existing backup.Delete an existing key backup.

room keys-version

Create a new backup.Get information about the latest backup version.

room keys-keys-{room Id}-{session Id}

Store a key in the backup.Retrieve a key from the backup.Delete a key from the backup.

room keys-keys-{room Id}

Store several keys in the backup for a given room.Retrieve the keys from the backup for a given room.Delete the keys from the backup for a given room.

Store several keys in the backup.Retrieve the keys from the backup.Delete the keys from the backup.

Matrix Client-Server Event Context API

Get events and state around the specified event.

Matrix Client-Server Registration API

Register for an account on this homeserver.Begins the validation process for an email to be used during registration.Requests a validation token be sent to the given phone number for the purpose of registering an account Checks to see if a username is available on the server.

account-password

Changes a user's password.Requests a validation token be sent to the given email address for the purpose of resetting a user's password Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.

Deactivate a user's account.

Matrix Client-Server Push API

Gets the current pushers for the authenticated user Modify a pusher for this user on the homeserver.

Matrix Client-Server Sync Guest API

Listen on the event stream of a particular room.

Matrix Client-Server Notifications API

Gets a list of events that the user has been notified about

Matrix Federation Event Authorization API

Get the auth chain for a given event

Matrix Federation Query API

Query for information Query for the room ID and resident homeservers for a room alias Query for profile information about a given user

Matrix Federation Join Room API

Submit a signed join event to a resident server Get information required to make a join event for a room

Matrix Client-Server message redaction API

Strips all non-integrity-critical information out of an event.

Matrix Client-Server Room Directory API

directory/list/room/{room Id}

Gets the visibility of a room in the directory Sets the visibility of a room in the room directory

Lists the public rooms on the server.Lists the public rooms on the server with optional filter.

Matrix Federation Space Hierarchy API

Retrieve a portion of a space tree.

Matrix Client-Server Administration API

Gets information about a particular user.

Matrix Client-Server User Directory API

Searches the user directory.

Matrix Application Service API

thirdparty-user

Reverse-lookup third party users given a Matrix User ID.Retrieve the Matrix User ID of a corresponding third party user.

thirdparty-location

Reverse-lookup third party locations given a Matrix room alias.Retrieve Matrix-side portal rooms leading to a third party location.

Retrieve metadata about a specific protocol that the application service supports.

Send some events to the application service.Query if a user should exist on the application service.Query if a room alias should exist on the application service.

Matrix Client-Server Directory API

directory/room/{room Alias}

Create a new mapping from room alias to room ID.Get the room ID corresponding to this room alias.Remove a mapping of room alias to room ID.

Get a list of local aliases on a given room.

Matrix Federation Transaction API

Send a transaction

Matrix Identity Service Lookup API

Gets hash function information from the server.Look up Matrix User IDs for a set of 3PIDs.

Matrix Federation Leave Room API

Get information required to make a leave event for a room Submit a signed leave event to a resident server

Matrix Federation OpenID API

Exchange an OpenID token for user information

Matrix Federation Server Discovery API

Gets information about the delegated server for server-server communication.

Matrix Identity Service Ping API

Checks that an identity server is available at this API endpoint.

Matrix Client-Server Versions API

Gets the versions of the specification supported by the server.

Matrix Client-Server Profile API

profile/{user Id}-displayname

Set the user's display name.Get the user's display name.

profile/{user Id}-avatar url

Set the user's avatar URL.Get the user's avatar URL.

profile/{user Id}

Get this user's profile information.

Matrix Client-Server Room Creation API

Create a new room

Matrix Federation User Key Management API

Claims one-time encryption keys for a user.Download device identity keys.

Matrix Identity Service Phone Number Associations API

validate/msisdn-submit Token

Validate ownership of a phone number.Validate ownership of a phone number.

validate/msisdn

Request a token for validating a phone number.

Matrix Client-Server Receipts API

Send a receipt for the given event ID.

Matrix Client-Server Account Identification API

Gets information about the owner of an access token.

Matrix Client-Server Client Config API

Upload end-to-end encryption keys.Download device identity keys.Claim one-time encryption keys.Query users with recent device key updates.

user/{user Id}-account data/{type}

Set some account_data for the user.Get some account_data for the user.

user/{user Id}-rooms/{room Id}/account data/{type}

Set some account_data for the user.Get some account_data for the user.

Matrix Client-Server Room Leaving API

rooms/{room Id}

Stop the requesting user participating in a particular room.Stop the requesting user remembering about a particular room.

Matrix Client-Server Presence API

presence/{user Id}/status

Update this user's presence state.Get this user's presence state.

Matrix Client-Server Server Discovery API

Gets Matrix server discovery information about the domain.

Matrix Client-Server Read Marker API

Set the position of the read marker for a room.

Matrix Identity Service Terms of Service API

Gets the terms of service offered by the server.Indicates acceptance of terms to the server.

Matrix Client-Server Room Joining API

Invite a user to participate in a particular room.

Matrix Client-Server Space Hierarchy API

Retrieve a portion of a space tree.

Matrix Client-Server Voice over IP API

Obtain TURN server credentials.

Matrix Client-Server Room Banning API

rooms/{room Id}

Ban a user in the room.Unban a user from the room.

Matrix Client-Server state event send API

Send a state event to the given room.

Matrix Identity Service Versions API

Gets the versions of the specification supported by the server.

Matrix Identity Service Establishing Associations API

Check whether ownership of a 3pid was validated.Publish an association between a session and a Matrix user ID.Remove an association between a session and a Matrix user ID.

Matrix Identity Service Public Key API

Get a public key.Check whether a long-term public key is valid.Check whether a short-term public key is valid.

Matrix Client-Server Room Kicking API

Kick a user from the room.

Matrix Client-Server tag API

user/{user Id}/rooms/{room Id}/tags-{tag}

Add a tag to a room.Remove a tag from the room.

user/{user Id}/rooms/{room Id}/tags

List the tags for a room.

Matrix Client-Server Room Inviting API

Start the requesting user participating in a particular room.Start the requesting user participating in a particular room.

Matrix Client-Server Sync API

Listen on the event stream.Get a single event by event ID.

Get the user's current state.

Matrix Federation Third Party Invites API

Request a server to auth a third party invite event Notifies the server that a third party identifier has been bound to one of its users.

Matrix Client-Server Capabilities API

Gets information about the server's capabilities.

Matrix Client-Server Send-to-device API

Send an event to a given set of devices.

Matrix Client-Server Search API

Perform a server-side search.

Matrix Client-Server Room Membership API for third party identifiers

Invite a user to participate in a particular room.

Matrix Federation Events API

Get all the state of a given room Get all the state event IDs of a given room Get a single event Retrieves the events which precede the given event Retrieves events that the sender is missing

Matrix Push Notification API

Notify a push gateway about an event.

Home Matrix Client-Server Registration APIaccount

account

Number of APIs: 1

Deactivate a user's account. POST {{baseUrl}}/account/deactivate

Requests a validation token be sent to the given phone number for the purpose of resetting a user's password.

Deactivate a user's account.