ffbe66a389
* fix relrefs around trends and related entities * revert moving caption-links to middle of page * hide empty menu in table of contents * clarify edit notifs are only for boosted statuses * following/followers no longer need auth * fix typo * specify cooldown period for account Move * use the correct cooldown * add missing parameters to accounts/id/statuses * link to account_statuses_filter.rb * fix typo (#1072) * fix typo (#1073) * fix link to http sig spec (#1067) * simply HTTP request examples in api methods docs * add missing client_secret to oauth/token (#1062) * Add any, all, none to hashtag timeline * minor formatting changes * Update signature requirements and advice * fix public key -> private key * clarify use of RSA with SHA256 * Add note about saving your profile after adding rel-me link * v2 filters api * comment out params that shouldn't be used in v2 filter api * admin trends * remove old todo * canonical email blocks + scheduled statuses * remove under-construction warnings from finished pages * verify api method params with source code * fix typo (#1088) * fix broken caption-links (#1100) * fix formatting of entities (#1094) * Remove keybase section from user guide (#1093) * fix typos (#1092) * Verify limits are accurate (#1086) * add mention of iframe limitation (#1084) * Add CORS header to WEB_DOMAIN example (#1083) * Fix typo (#1081) * pin http sigs spec at draft 8 * Revert "pin http sigs spec at draft 8" This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20. * add case sensitivity warning to 4.0 roles * Add url length note to bio (#1087) * remove follow scope from examples (#1103) * clarify usage of update_credentials to update profile fields * add noindex to Account entitity * remove required hint from technically not required property
2.4 KiB
| title | description | menu | aliases | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| blocks API methods | View your blocks. See also accounts/:id/{block,unblock} |
|
|
View blocked users
GET /api/v1/blocks HTTP/1.1
Returns: Array of [Account]({{< relref "entities/account" >}})
OAuth: User token + read:blocks
Version history:
0.0.0 - added
3.3.0 - both min_id and max_id can be used at the same time now
Request
Headers
- Authorization
- {{}} Provide this header with
Bearer <user token>to gain authorized access to this API method.
Query parameters
- max_id
- Internal parameter. Use HTTP
Linkheader for pagination. - since_id
- Internal parameter. Use HTTP
Linkheader for pagination. - min_id
- Internal parameter. Use HTTP
Linkheader for pagination. - limit
- Integer. Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts.
Response
200: OK
Sample call with limit=2.
[
{
"id": "585315",
"username": "admin",
"acct": "admin@happylittle.cloudns.cc",
"display_name": "☁️ ⛅ Happy Little Clouds ⛅ ☁️",
// ...
},
{
"id": "650568",
"username": "Nikolai_Kingsley",
"acct": "Nikolai_Kingsley@dobbs.town",
"display_name": "Rev.Dr. Nikolai Kingsley",
// ...
}
]
Because Block IDs are generally not exposed via any API responses, you will have to parse the HTTP Link header to load older or newer results. See [Paginating through API responses]({{<relref "api/guidelines#pagination">}}) for more information.
Link: <https://mastodon.example/api/v1/blocks?limit=2&max_id=441449>; rel="next", <https://mastodon.example/api/v1/blocks?limit=2&since_id=444808>; rel="prev"
401: Unauthorized
Invalid or missing Authorization header.
{
"error": "The access token is invalid"
}
See also
{{< page-relref ref="methods/accounts#block" caption="POST /api/v1/accounts/:id/block" >}}
{{< page-relref ref="methods/accounts#unblock" caption="POST /api/v1/accounts/:id/unblock" >}}
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/blocks_controller.rb" caption="app/controllers/api/v1/blocks_controller.rb" >}}