Third-party Lookup

Reverse-lookup third-party locations given a Matrix room alias.

Retrieve an array of third-party network locations from a Matrix room alias.

get/_matrix/client/v3/thirdparty/location

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/thirdparty/location/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

aliasstring required

The Matrix room alias to look up.

Response

All found third-party locations.

aliasstring required

An alias for a matrix room.

fieldsobject required

Information used to identify this third-party location.

protocolstring required

The protocol ID that the third-party location is a part of.

Example response

[
  {
    "alias": "#freenode_#matrix:matrix.org",
    "fields": {
      "channel": "#matrix",
      "network": "freenode"
    },
    "protocol": "irc"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.