Matrix

Matrix Join API

The Join API from Matrix — 1 operation(s) for join.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/matrix/refs/heads/main/openapi/matrix-join-api-openapi.yml

OpenAPI Specification

matrix-join-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Matrix Client-Server Account Join API
  version: v3
  description: 'REST API used by Matrix clients to communicate with a homeserver. Covers

    login, account management, sync, room creation and membership, message

    send and history, profile and presence, device management, end-to-end

    encryption keys, and the public rooms directory. Newer endpoints sit

    under /_matrix/client/v3 with selected features under /v1.

    '
  contact:
    name: Matrix.org Foundation
    url: https://matrix.org
servers:
- url: https://{homeserver}/_matrix/client
  description: Matrix homeserver Client-Server API root
  variables:
    homeserver:
      default: matrix.org
security:
- BearerAuth: []
tags:
- name: Join
paths:
  /v3/join/{roomIdOrAlias}:
    post:
      summary: Join a room by ID or alias
      operationId: joinRoom
      parameters:
      - in: path
        name: roomIdOrAlias
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Joined.
      tags:
      - Join
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Matrix access token issued by the homeserver after login, passed as

        `Authorization: Bearer {access_token}`. Some endpoints (login,

        register, refresh) do not require authentication.

        '