Mastodon
  • What is Mastodon?
  • Using Mastodon
    • Signing up for an account
    • Setting up your profile
    • Posting toots
    • Using the network features
    • Dealing with unwanted content
    • Promoting yourself and others
    • Set your preferences
    • More settings
    • Using Mastodon externally
    • Moving or leaving accounts
    • Running your own server
  • Running Mastodon
    • Preparing your machine
    • Installing from source
    • Configuring your environment
    • Installing optional features
      • Full-text search
      • Hidden services
      • Single Sign On
    • Setting up your new instance
    • Using the admin CLI
    • Upgrading to a new release
    • Backing up your server
    • Migrating to a new machine
    • Scaling up your server
    • Moderation actions
    • Troubleshooting errors
      • Database index corruption
  • Developing Mastodon apps
    • Getting started with the API
    • Playing with public data
    • Obtaining client app access
    • Logging in with an account
    • Guidelines and best practices
    • Libraries and implementations
  • Contributing to Mastodon
    • Technical overview
    • Setting up a dev environment
    • Code structure
    • Routes
    • Bug bounties and responsible disclosure
  • Spec compliance
    • ActivityPub
    • WebFinger
    • Security
    • Microformats
    • OAuth
    • Bearcaps
  • REST API
    • OAuth Scopes
    • Rate limits
  • API Methods
    • apps
      • oauth
    • accounts
      • bookmarks
      • favourites
      • mutes
      • blocks
      • domain_blocks
      • filters
      • reports
      • follow_requests
      • endorsements
      • featured_tags
      • preferences
      • suggestions
    • statuses
      • media
      • polls
      • scheduled_statuses
    • timelines
      • conversations
      • lists
      • markers
      • streaming
    • notifications
      • push
    • search
    • instance
      • trends
      • directory
      • custom_emojis
    • admin
    • announcements
    • proofs
    • oembed
  • API Entities
    • Account
    • Activity
    • Admin::Account
    • Admin::Report
    • Announcement
    • AnnouncementReaction
    • Application
    • Attachment
    • Card
    • Context
    • Conversation
    • Emoji
    • Error
    • FeaturedTag
    • Field
    • Filter
    • History
    • IdentityProof
    • Instance
    • List
    • Marker
    • Mention
    • Notification
    • Poll
    • Preferences
    • PushSubscription
    • Relationship
    • Report
    • Results
    • ScheduledStatus
    • Source
    • Status
    • Tag
    • Token

mutes

View your mutes. See also accounts/:id/{mute,unmute}

get
Muted accounts

https://mastodon.example/api/v1/mutes

Accounts the user has muted.

Returns: Array of Account
OAuth: User token + read:mutes or follow
Version history:
0.0.0 - added

Request

Headers
Authorization
required
string
Bearer <user token>
Form Data Parameters
limit
optional
string
Maximum number of results to return per page. Defaults to 40.
max_id
optional
string
Internal parameter. Use the HTTP Link header for pagination instead.
since_id
optional
string
Internal parameter. Use the HTTP Link header for pagination instead.

Response

200: Success

Sample response with limit=2. The id of mutes is private, so parse the HTTP Link header to find links to next and previous pages.

Link: <https://mastodon.social/api/v1/mutes?limit=2&max_id=317646>; rel="next", <https://mastodon.social/api/v1/mutes?limit=2&since_id=317647>; rel="prev"

[
  {
    "id": "963076",
    "username": "Simia91",
    "acct": "Simia91",
    "display_name": "",
    "locked": false,
    "bot": false,
    "created_at": "2019-11-07T10:31:17.428Z",
    "note": "<p></p>",
    "url": "https://mastodon.social/@Simia91",
    "avatar": "https://files.mastodon.social/accounts/avatars/000/963/076/original/30d3e0502c419cca.png",
    "avatar_static": "https://files.mastodon.social/accounts/avatars/000/963/076/original/30d3e0502c419cca.png",
    "header": "https://files.mastodon.social/accounts/headers/000/963/076/original/53ba9b1ad4922418.jpg",
    "header_static": "https://files.mastodon.social/accounts/headers/000/963/076/original/53ba9b1ad4922418.jpg",
    "followers_count": 18,
    "following_count": 73,
    "statuses_count": 640,
    "last_status_at": "2019-11-19T15:14:47.088Z",
    "mute_expires_at": null,
    "emojis": [],
    "fields": []
  },
  {
    "id": "1001524",
    "username": "hakogamae",
    "acct": "hakogamae",
    "display_name": "Hakogamae 馃敒",
    "locked": false,
    "bot": false,
    "created_at": "2019-11-15T13:01:55.538Z",
    "note": "<p>This blog is going to be about what I don&apos;t know -- what&apos;s the diff between good for me and not? </p><p>I always to make reasonable choices, but I&apos;ve been wrong many times.  Maybe I&apos;ll get better by simply working at it slowly.</p><p>&quot;If I have the belief that I can do it,<br />I shall surely acquire the capacity to<br />do it even if I may not have it at the<br />beginning.&quot; -- Gandhi</p><p>My name -- Hakogamae -- comes from the Japanese Kanji  Radical 22 鍖氶儴 meaning &quot;box.&quot;  I&apos;m in a box now.</p><p>At Humblr, I was Fslowly</p>",
    "url": "https://mastodon.social/@hakogamae",
    "avatar": "https://files.mastodon.social/accounts/avatars/001/001/524/original/dd6ab3001057a144.jpg",
    "avatar_static": "https://files.mastodon.social/accounts/avatars/001/001/524/original/dd6ab3001057a144.jpg",
    "header": "https://files.mastodon.social/accounts/headers/001/001/524/original/09187eeac3fa6d0d.jpg",
    "header_static": "https://files.mastodon.social/accounts/headers/001/001/524/original/09187eeac3fa6d0d.jpg",
    "followers_count": 23,
    "following_count": 0,
    "statuses_count": 137,
    "last_status_at": "2019-11-21T18:44:25.570Z",
    "mute_expires_at": null,
    "emojis": [],
    "fields": [
      {
        "name": "Men",
        "value": "living, alive",
        "verified_at": null
      },
      {
        "name": "Carpe diem",
        "value": "鍖氶儴",
        "verified_at": null
      },
      {
        "name": "Photographs",
        "value": "capturing time",
        "verified_at": null
      },
      {
        "name": "Feedback",
        "value": "always helps",
        "verified_at": null
      }
    ]
  }
]

401: Unauthorized

If the Authorization header is not provided or contains an invalid token, the request will fail.

{
  "error": "The access token is invalid"
}

Last updated December 27, 2020 路 Improve this page

Sponsored by

Dotcom-Monitor LoadView Stephen Tures Swayable

Join Mastodon 路 Blog 路 路

View source 路 CC BY-SA 4.0 路 Imprint