admin

Perform moderation actions with accounts and reports.

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

Account methods

get
View accounts by criteria

https://CounterSocial.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

Request

Headers
Authorization
required
string
Bearer
Query Parameters
local
optional
boolean
Filter for local accounts?
remote
optional
boolean
Filter for remote accounts?
by_domain
optional
string
Filter by the given domain
active
optional
boolean
Filter for currently active accounts?
pending
optional
boolean
Filter for currently pending accounts?
disabled
optional
boolean
Filter for currently disabled accounts?
silenced
optional
boolean
Filter for currently silenced accounts?
suspended
optional
boolean
Filter for currently suspended accounts?
username
optional
string
Username to search for
display_name
optional
string
Display name to search for
email
optional
string
Lookup a user with this email
ip
optional
string
Lookup users by this IP address
staff
optional
boolean
Filter for staff accounts?

Response

200: Success

get
View a specific account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Perform an action against an account

https://CounterSocial.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

Request

Path Parameters
:account_id
required
string
ID of the account
Headers
Authorization
required
string
Bearer
Form Data Parameters
type
optional
string
Type of action to be taken. Enumerable oneOf: none disable silence suspend
report_id
optional
string
ID of an associated report that caused this action to be taken
warning_preset_id
optional
string
ID of a preset warning
text
optional
string
Additional text for clarification of why this action was taken
send_email_notification
optional
boolean
Whether an email should be sent to the user with the above information.

Response

200: Success

post
Approve pending account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Reject pending account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Re-enable account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Unsilence account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Unsuspend account

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the account
Headers
Authorization
required
string
Bearer

Response

200: Success

Report methods

get
View all reports

https://CounterSocial.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

Request

Headers
Authorization
required
string
Bearer
Query Parameters
resolved
optional
boolean
account_id
optional
string
target_account_id
optional
string

Response

200: Success

get
View a single report

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the report
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Assign report to self

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the report
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Unassign report

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the report
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Mark as resolved

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the report
Headers
Authorization
required
string
Bearer

Response

200: Success

post
Re-open report

https://CounterSocial.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

Request

Path Parameters
:id
required
string
ID of the report
Headers
Authorization
required
string
Bearer

Response

200: Success

Last updated December 27, 2020 ?? Improve this page