aboutsummaryrefslogtreecommitdiff
path: root/docs/API/differences_in_mastoapi_responses.md
diff options
context:
space:
mode:
authorfeld <feld@feld.me>2019-10-14 19:40:40 +0000
committerfeld <feld@feld.me>2019-10-14 19:40:40 +0000
commit3b1bc079af8fb6e467a9114de0d32e2de59a7fab (patch)
tree098012ed8206f9ed41fdf80944f6eaba7f40be40 /docs/API/differences_in_mastoapi_responses.md
parente0da0d4f9e669b34afe975e39ae21a558bf4c25c (diff)
parenta97b642289659a5fccb5943c54caa1ecdce5fd2f (diff)
downloadpleroma-3b1bc079af8fb6e467a9114de0d32e2de59a7fab.tar.gz
Merge branch 'exclude-visibilities-for-timelines' into 'develop'
Mastodon API: Add `exclude_visibilities` parameter to the timeline and notification endpoints See merge request pleroma/pleroma!1818
Diffstat (limited to 'docs/API/differences_in_mastoapi_responses.md')
-rw-r--r--docs/API/differences_in_mastoapi_responses.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
index 21b297529..aca0f5e0e 100644
--- a/docs/API/differences_in_mastoapi_responses.md
+++ b/docs/API/differences_in_mastoapi_responses.md
@@ -13,6 +13,7 @@ Some apps operate under the assumption that no more than 4 attachments can be re
## Timelines
Adding the parameter `with_muted=true` to the timeline queries will also return activities by muted (not by blocked!) users.
+Adding the parameter `exclude_visibilities` to the timeline queries will exclude the statuses with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`), e.g., `exclude_visibilities[]=direct&exclude_visibilities[]=private`.
## Statuses
@@ -84,6 +85,12 @@ Has these additional fields under the `pleroma` object:
- `is_seen`: true if the notification was read by the user
+## GET `/api/v1/notifications`
+
+Accepts additional parameters:
+
+- `exclude_visibilities`: will exclude the notifications for activities with the given visibilities. The parameter accepts an array of visibility types (`public`, `unlisted`, `private`, `direct`). Usage example: `GET /api/v1/notifications?exclude_visibilities[]=direct&exclude_visibilities[]=private`.
+
## POST `/api/v1/statuses`
Additional parameters can be added to the JSON body/Form data: