---
title: "Retrieve Matrix-side portals rooms leading to a third-party location."
method: GET
path: "/_matrix/client/v3/thirdparty/location/{protocol}"
tags: ["Third-party Lookup"]
---

# Retrieve Matrix-side portals rooms leading to a third-party location.

`GET /_matrix/client/v3/thirdparty/location/{protocol}`

## Request

- Base URL: `https://matrix.org`
- URL: `https://matrix.org/_matrix/client/v3/thirdparty/location/{protocol}`
- Auth: one of:
  - API key in query parameter `access_token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v3/thirdparty/location/:protocol/get.ts> (a function with typed inputs; its response is checked against the schema)

Requesting this endpoint with a valid protocol name results in a list
of successful mapping results in a JSON array. Each result contains
objects to represent the Matrix room or rooms that represent a portal
to this third-party network. Each has the Matrix room alias string,
an identifier for the particular third-party network protocol, and an
object containing the network-specific fields that comprise this
identifier. It should attempt to canonicalise the identifier as much
as reasonably possible given the network type.

## Path parameters

- `protocol` string, required

## Query parameters

- `fields` object

## Response `200`

At least one portal room was found.

- object[]: List of matched third-party locations.
  - `alias` string, required: An alias for a matrix room.
  - `fields` object, required: Information used to identify this third-party location.
  - `protocol` string, required: The protocol ID that the third-party location is a part of.

## Other responses

- `404`: No portal rooms were found.

---

[API](https://skmtc.dev/matrix/apis/matrix-client-server-api.md) - [All operations](https://skmtc.dev/matrix/apis/matrix-client-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/matrix/apis/matrix-client-server-api/revisions/c7fe4072c681?raw)