Skip to content

List the users you have blocked

GET
/account/blocked

Returns the users you have blocked, most recently blocked first, with the reason you gave, if any.

You need to be signed in; no capability is needed. Without a session cookie or bearer token that identifies you, the answer is 401, whether or not public mode is on. A limit that isn’t a whole number, or that is given more than once, gets a plain-text 400 before sign-in is checked.

The list isn’t paginated: there is no cursor, so you get at most limit users, 50 unless you ask for another number; values below 1 count as 1 and above 200 as 200. If you have blocked more than 200 people, the older blocks can’t be listed here. Users blocked at the same moment come in a fixed order by ref.

Only your own blocks are listed, and no capability shows anyone else’s. This list doesn’t show who has blocked you, although getUserRelationship tells you whether a given user has.

Each entry shows the account as it is now: its username and, when set, its display name and picture, whatever the account’s status. An account that has been removed completely drops off the list, although the block itself stays. since is when the current block started. Blocking someone you have already blocked replaces the reason, or clears it if you give none, and keeps that time; unblocking them and blocking again starts a new block with a new time.

The reason is shown only to you here, but it is also kept with the block’s record in the activity log, which administrators who can read that log can see. The list is read fresh each time, while other parts of the API check blocks through a cache and can lag behind it. Server errors get a plain-text 500.

limit
integer
default: 50 >= 1 <= 200

How many users to return, 50 if left out; values below 1 count as 1 and above 200 as 200. There is no next page.

Up to limit users you have blocked, most recently blocked first.

object
users
required

The users you have blocked, most recently blocked first; empty when there are none.

Array<object>
object
ref
required

The blocked user’s ref.

integer format: int64
username
required

Their current username. It can be empty.

string
display_name

Their current display name; left out when none is set, and it can be empty.

string
nullable
avatar_url

Their current profile picture’s URL; left out when none is set.

string
nullable
reason

The reason you gave the last time you blocked them; left out when you gave none.

string
nullable
since
required

When the current block started. Blocking them again while the block stands doesn’t change it; unblocking and blocking again gives a new time.

string format: date-time

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}