search
HomepageSponsorsApps

admin

Perform moderation actions with accounts and reports.

circle-exclamation

Responses are not currently documented. Exact nature of parameters has not been validated.

hashtag
Account methods

hashtag
View accounts by criteria

GET https://mastodon.example/api/v1/admin/accounts

View accounts matching certain criteria for filtering, up to 100 at a time. Pagination may be done with the HTTP Link header in the response. Returns: Admin::Account OAuth: User token + admin:read:accounts Version history: 2.9.1 - added

hashtag
Query Parameters

Name
Type
Description

local

boolean

Filter for local accounts?

remote

boolean

Filter for remote accounts?

by_domain

string

Filter by the given domain

active

boolean

Filter for currently active accounts?

pending

boolean

Filter for currently pending accounts?

disabled

boolean

Filter for currently disabled accounts?

silenced

boolean

Filter for currently silenced accounts?

suspended

boolean

Filter for currently suspended accounts?

username

string

Username to search for

display_name

string

Display name to search for

email

string

Lookup a user with this email

ip

string

Lookup users by this IP address

staff

boolean

Filter for staff accounts?

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
View a specific account

GET https://mastodon.example/api/v1/admin/accounts/:id

View admin-level information about the given account. Returns: Admin::Account OAuth: User token + admin:read:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Perform an action against an account

POST https://mastodon.example/api/v1/admin/accounts/:account_id/action

Perform an action against an account and log this action in the moderation history. Returns: empty object OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:account_id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Request Body

Name
Type
Description

type

string

Type of action to be taken. Enumerable oneOf: none disable silence suspend

report_id

string

ID of an associated report that caused this action to be taken

warning_preset_id

string

ID of a preset warning

text

string

Additional text for clarification of why this action was taken

send_email_notification

boolean

Whether an email should be sent to the user with the above information.

hashtag
Approve pending account

POST https://mastodon.example/api/v1/admin/accounts/:id/approve

Approve the given local account if it is currently pending approval. Returns: Admin::Account OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Reject pending account

POST https://mastodon.example/api/v1/admin/accounts/:id/reject

Reject the given local account if it is currently pending approval. Returns: Admin::Account OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Re-enable account

POST https://mastodon.example/api/v1/admin/accounts/:id/enable

Re-enable a local account whose login is currently disabled. Returns: Admin::Account OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Unsilence account

POST https://mastodon.example/api/v1/admin/accounts/:id/unsilence

Unsilence a currently silenced account. Returns: Admin::Account OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Unsuspend account

POST https://mastodon.example/api/v1/admin/accounts/:id/unsuspend

Unsuspend a currently suspended account. Returns: Admin::Account OAuth: User token + admin:write:accounts Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the account

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Report methods

hashtag
View all reports

GET https://mastodon.example/api/v1/admin/reports

View all reports. Pagination may be done with HTTP Link header in the response. Returns: Array of Admin::Report OAuth: User token + admin:read:reports Version history: 2.9.1 - added

hashtag
Query Parameters

Name
Type
Description

resolved

boolean

account_id

string

target_account_id

string

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
View a single report

GET https://mastodon.example/api/v1/admin/reports/:id/

View information about the report with the given ID. Returns: Admin::Report OAuth: User token + admin:read:reports Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the report

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Assign report to self

POST https://mastodon.example/api/v1/admin/reports/:id/assign_to_self

Claim the handling of this report to yourself. Returns: Admin::Report OAuth: User token + admin:write:reports Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the report

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Unassign report

POST https://mastodon.example/api/v1/admin/reports/:id/unassign

Unassign a report so that someone else can claim it. Returns: Admin::Report OAuth: User token + admin:write:reports Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the report

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Mark as resolved

POST https://mastodon.example/api/v1/admin/reports/:id/resolve

Mark a report as resolved with no further action taken. Returns: Admin::Report OAuth: User token + admin:write:reports Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the report

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

hashtag
Re-open report

POST https://mastodon.example/api/v1/admin/reports/:id/reopen

Reopen a currently closed report. Returns: Admin::Report OAuth: User token + admin:write:reports Version history: 2.9.1 - added

hashtag
Path Parameters

Name
Type
Description

:id

string

ID of the report

hashtag
Headers

Name
Type
Description

Authorization

string

Bearer <user token>

Previouscustom_emojisNextproofs

Last updated

Was this helpful?