Server administration

Gets information about the suspended status of a particular user.

Gets information about the suspended status of a particular server-local user.

The user calling this endpoint MUST be a server admin.

In order to prevent user enumeration, servers MUST ensure that authorisation is checked prior to trying to do account lookups.

get/_matrix/client/v1/admin/suspend/{userId}

Request

Base URL
https://matrix.org
Auth
- API key in query parameter access_token
- or HTTP bearer
TypeScript
https://skmtc.dev/matrix/apis/matrix-client-server-api/docs/_matrix/client/v1/admin/suspend/:userId/get.ts
A function with typed inputs. Its response is checked against the schema.

userIdstring mx-user-id required

The user to look up.

The lookup was successful.

suspendedboolean required

Whether the target account is suspended.

{
  "suspended": true
}

No recorded changes to this operation across all 1 revision of this API.