Matrix

Matrix Login API

The Login API from Matrix — 1 operation(s) for login.

Documentation GitHub OpenAPI

Operations 2

GET /v3/login List supported login flows #

Specifications

⚙

OpenAPI

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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/matrix-login-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Matrix Client-Server Account Login 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: Login
paths:
  /v3/login:
    get:
      summary: List supported login flows
      operationId: getLoginFlows
      security: []
      responses:
        '200':
          description: Supported login flows.
      tags:
      - Login
    post:
      summary: Authenticate and obtain an access token
      operationId: login
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              properties:
                type:
                  type: string
                  description: e.g. `m.login.password`
                identifier:
                  type: object
                password:
                  type: string
                device_id:
                  type: string
                initial_device_display_name:
                  type: string
                refresh_token:
                  type: boolean
      responses:
        '200':
          description: Access token issued.
      tags:
      - Login
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.

        '