mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
3628b6d434
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
397 lines
8.3 KiB
Markdown
397 lines
8.3 KiB
Markdown
---
|
|
title: notifications API methods
|
|
description: Receive notifications for activity on your account or statuses.
|
|
menu:
|
|
docs:
|
|
weight: 50
|
|
name: notifications
|
|
parent: methods
|
|
identifier: methods-notifications
|
|
aliases: [
|
|
"/methods/notifications",
|
|
"/api/methods/notifications",
|
|
]
|
|
---
|
|
|
|
<style>
|
|
#TableOfContents ul ul ul {display: none}
|
|
</style>
|
|
|
|
## Get all notifications {#get}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/notifications HTTP/1.1
|
|
```
|
|
|
|
Notifications concerning the user. This API returns Link headers containing links to the next/previous page. However, the links can also be constructed dynamically using query params and `id` values.
|
|
|
|
Types to filter include:
|
|
- `mention` = Someone mentioned you in their status
|
|
- `status` = Someone you enabled notifications for has posted a status
|
|
- `reblog` = Someone boosted one of your statuses
|
|
- `follow` = Someone followed you
|
|
- `follow_request` = Someone requested to follow you
|
|
- `favourite` = Someone favourited one of your statuses
|
|
- `poll` = A poll you have voted in or created has ended
|
|
- `update` = A status you interacted with has been edited
|
|
- `admin.sign_up` = Someone signed up (optionally sent to admins)
|
|
- `admin.report` = A new report has been filed
|
|
|
|
**Returns:** Array of [Notification]({{< relref "entities/Notification" >}})\
|
|
**OAuth:** User token + `read:notifications`\
|
|
**Version history:**\
|
|
0.0.0 - added\
|
|
2.6.0 - added `min_id`\
|
|
2.9.0 - added `account_id`\
|
|
3.1.0 - added `follow_request` type\
|
|
3.3.0 - added `status` type; both `min_id` and `max_id` can be used at the same time now\
|
|
3.5.0 - added `types`; add `update` and `admin.sign_up` types\
|
|
4.0.0 - added `admin.report` type
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
max_id
|
|
: String. Return results older than this ID
|
|
|
|
since_id
|
|
: String. Return results newer than this ID
|
|
|
|
min_id
|
|
: String. Return results immediately newer than this ID
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Default: 20.
|
|
|
|
types[]
|
|
: Array of String. Types to include in the result.
|
|
|
|
exclude_types[]
|
|
: Array of String. Types to exclude from the results.
|
|
|
|
account_id
|
|
: String. Return only notifications received from the specified account.
|
|
|
|
#### Response
|
|
|
|
Sample call with limit=2.
|
|
|
|
```http
|
|
GET https://mastodon.social/api/v1/notifications?limit=2 HTTP/1.1
|
|
Authorization: Bearer xxx
|
|
```
|
|
|
|
##### 200: OK
|
|
|
|
The response body contains one page of notifications. You can use the HTTP Link header for further pagination.
|
|
|
|
```http
|
|
Link: <https://mastodon.social/api/v1/notifications?max_id=34975535>; rel="next", <https://mastodon.social/api/v1/notifications?min_id=34975861>;
|
|
```
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "34975861",
|
|
"type": "mention",
|
|
"created_at": "2019-11-23T07:49:02.064Z",
|
|
"account": {
|
|
"id": "971724",
|
|
"username": "zsc",
|
|
"acct": "zsc",
|
|
// ...
|
|
},
|
|
"status": {
|
|
"id": "103186126728896492",
|
|
"created_at": "2019-11-23T07:49:01.940Z",
|
|
"in_reply_to_id": "103186038209478945",
|
|
"in_reply_to_account_id": "14715",
|
|
// ...
|
|
"content": "<p><span class=\"h-card\"><a href=\"https://mastodon.social/@trwnh\" class=\"u-url mention\">@<span>trwnh</span></a></span> sup!</p>",
|
|
// ...
|
|
"account": {
|
|
"id": "971724",
|
|
"username": "zsc",
|
|
"acct": "zsc",
|
|
// ...
|
|
},
|
|
// ...
|
|
"mentions": [
|
|
{
|
|
"id": "14715",
|
|
"username": "trwnh",
|
|
"url": "https://mastodon.social/@trwnh",
|
|
"acct": "trwnh"
|
|
}
|
|
],
|
|
// ...
|
|
}
|
|
},
|
|
{
|
|
"id": "34975535",
|
|
"type": "favourite",
|
|
"created_at": "2019-11-23T07:29:18.903Z",
|
|
"account": {
|
|
"id": "297420",
|
|
"username": "haskal",
|
|
"acct": "haskal@cybre.space",
|
|
// ...
|
|
},
|
|
"status": {
|
|
"id": "103186046267791694",
|
|
"created_at": "2019-11-23T07:28:34.210Z",
|
|
"in_reply_to_id": "103186044372624124",
|
|
"in_reply_to_account_id": "297420",
|
|
// ...
|
|
"account": {
|
|
"id": "14715",
|
|
"username": "trwnh",
|
|
"acct": "trwnh",
|
|
// ...
|
|
}
|
|
}
|
|
}
|
|
]
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Get a single notification {#get-one}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/notification/:id HTTP/1.1
|
|
```
|
|
|
|
View information about a notification with a given ID.
|
|
|
|
**Returns:** [Notification]({{< relref "entities/Notification" >}})\
|
|
**OAuth:** User token + `read:notifications`\
|
|
**Version history:**\
|
|
0.0.0 - added
|
|
|
|
#### Request
|
|
|
|
##### Path parameters
|
|
|
|
:id
|
|
: {{<required>}} String. The ID of the Notification in the database.
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
A single Notification
|
|
|
|
```json
|
|
{
|
|
"id": "34975861",
|
|
"type": "mention",
|
|
"created_at": "2019-11-23T07:49:02.064Z",
|
|
"account": {
|
|
"id": "971724",
|
|
"username": "zsc",
|
|
"acct": "zsc",
|
|
// ...
|
|
},
|
|
"status": {
|
|
"id": "103186126728896492",
|
|
"created_at": "2019-11-23T07:49:01.940Z",
|
|
"in_reply_to_id": "103186038209478945",
|
|
"in_reply_to_account_id": "14715",
|
|
// ...
|
|
"content": "<p><span class=\"h-card\"><a href=\"https://mastodon.social/@trwnh\" class=\"u-url mention\">@<span>trwnh</span></a></span> sup!</p>",
|
|
// ...
|
|
"account": {
|
|
"id": "971724",
|
|
"username": "zsc",
|
|
"acct": "zsc",
|
|
// ...
|
|
},
|
|
// ...
|
|
"mentions": [
|
|
{
|
|
"id": "14715",
|
|
"username": "trwnh",
|
|
"url": "https://mastodon.social/@trwnh",
|
|
"acct": "trwnh"
|
|
}
|
|
],
|
|
// ...
|
|
}
|
|
}
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Dismiss all notifications {#clear}
|
|
|
|
```http
|
|
POST https://mastodon.example/api/v1/notifications/clear HTTP/1.1
|
|
```
|
|
|
|
Clear all notifications from the server.
|
|
|
|
**Returns:** empty object\
|
|
**OAuth:** User token + `write:notifications`\
|
|
**Version history:**\
|
|
0.0.0 - added
|
|
|
|
#### Request
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
Notifications successfully cleared.
|
|
|
|
```json
|
|
{}
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Dismiss a single notification {#dismiss}
|
|
|
|
```http
|
|
POST https://mastodon.example/api/v1/notifications/:id/dismiss HTTP/1.1
|
|
```
|
|
|
|
Dismiss a single notification from the server.
|
|
|
|
**Returns:** empty object\
|
|
**OAuth:** User token + `write:notifications`\
|
|
**Version history:**\
|
|
1.3.0 - added
|
|
|
|
#### Request
|
|
|
|
##### Path parameters
|
|
|
|
:id
|
|
: {{<required>}} String. The ID of the Notification in the database.
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
Notification with given ID successfully dismissed
|
|
|
|
```json
|
|
{}
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## (REMOVED) Dismiss a single notification {#dismiss-deprecated}
|
|
|
|
```http
|
|
POST https://mastodon.example/api/v1/notifications/dismiss HTTP/1.1
|
|
```
|
|
|
|
Dismiss a single notification from the server.
|
|
|
|
**Returns:** empty object\
|
|
**OAuth:** User token + `write:notifications`\
|
|
**Version history**:\
|
|
0.0.0 - available\
|
|
1.3.0 - deprecated in favor of [notifications/:id/dismiss](#dismiss)
|
|
3.0.0 - removed
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Form data parameters
|
|
id
|
|
: {{<required>}} String. The ID of the notification in the database.
|
|
|
|
#### Response
|
|
|
|
##### 200: OK
|
|
|
|
Notification with given ID successfully dismissed
|
|
|
|
```json
|
|
{}
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## See also
|
|
|
|
{{< page-relref ref="methods/push" caption="push API methods" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/notifications_controller.rb" caption="app/controllers/api/v1/notifications_controller.rb" >}} |