Synapse · Example Payload

Synapse List Users Example

Example of listing users on a Synapse homeserver via the Admin API

ChatCollaborationDecentralizedFederationMatrixMessagingOpen-SourceReal-Time

Synapse List Users Example is an example object payload from Synapse, with 5 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

titledescriptionoperationrequestresponse

Example Payload

Raw ↑
{
  "title": "List Users",
  "description": "Example of listing users on a Synapse homeserver via the Admin API",
  "operation": "GET /v2/users",
  "request": {
    "headers": {
      "Authorization": "Bearer syt_admin_XXXXXXXXXXXXX"
    },
    "queryParams": {
      "limit": 10,
      "from": 0,
      "deactivated": false
    }
  },
  "response": {
    "status": 200,
    "body": {
      "users": [
        {
          "name": "@alice:example.com",
          "displayname": "Alice Johnson",
          "avatar_url": "mxc://example.com/AbCdEfGhIjKlMnOp",
          "is_guest": false,
          "admin": false,
          "deactivated": false,
          "erased": false,
          "shadow_banned": false,
          "creation_ts": 1700000000,
          "user_type": null
        },
        {
          "name": "@bob:example.com",
          "displayname": "Bob Smith",
          "avatar_url": null,
          "is_guest": false,
          "admin": true,
          "deactivated": false,
          "erased": false,
          "shadow_banned": false,
          "creation_ts": 1700100000,
          "user_type": null
        }
      ],
      "next_token": 10,
      "total": 42
    }
  }
}

Work with this as data

Every example 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 examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • 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 example
curl "https://apis.io/api/v1/examples/synapse-list-users-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

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

Get an API key

Free tier, no email required.

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