How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Synapse

Synapse Rooms API

Room administration and membership

Documentation Provider Profile APIs.io OpenAPI GitHub

Synapse Rooms API is one of 9 APIs that Synapse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rooms. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://matrix.example.com/_synapse/admin.

5 operations 4 paths 5 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://matrix.example.com/_matrix/client
Authentication
HTTP Bearer
Contact
Element (Synapse maintainers)
License
AGPL-3.0
Resource Areas
1

Authentication & Security 1

Synapse Rooms API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Admin access token obtained from the Synapse homeserver

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Rooms 5

Room administration and membership

GET
/v1/rooms
List All Rooms
listRooms 5 params → 200401403
GET
/v1/rooms/{roomId}
Get Room Details
getRoom 1 param → 200401403404
DELETE
/v1/rooms/{roomId}
Delete Room
deleteRoom 1 param body → 200400401403
GET
/v1/rooms/{roomId}/members
Get Room Members
getRoomMembers 1 param → 200401403
POST
/v1/join/{roomIdOrAlias}
Join User to Room
joinUserToRoom 1 param body → 200400401403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RoomSummary (14 properties), RoomList (5 properties), RoomMemberList (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Error
object
2 properties
RoomMemberList
object
2 properties
RoomSummary
object
14 properties
RoomList
object
5 properties
RoomDetail

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

synapse-rooms-api-openapi.yml Raw ↑

Other APIs Synapse publishes across the network.

Synapse Application Service API
AE Profile APIs.io
Synapse Federation API
AE Profile APIs.io
Synapse Media API
AE Profile APIs.io
Synapse Registration API
AE Profile APIs.io
Synapse Reports API
AE Profile APIs.io
Synapse Server API
AE Profile APIs.io
Synapse Statistics API
AE Profile APIs.io
Synapse Users API
AE Profile APIs.io
#Rooms
← Back to S APIs
API Details
ID
synapse:synapse-rooms-api
Base URL
https://matrix.example.com/_matrix/client
Docs
https://spec.matrix.org/latest/client-server-api/
Provider
Synapse
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=synapse-rooms-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/synapse-rooms-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Synapse Rooms API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.