Documentation
¶
Overview ¶
Package scope contains scope definitions for every Mastodon API route.
Index ¶
Constants ¶
const AdminRead = "admin:read"
AdminRead grants read access to every moderation endpoint, and is the parent of every admin:read: scope. https://docs.joinmastodon.org/api/oauth-scopes/#admin
const AdminReadAccounts = "admin:read:accounts"
AdminReadAccounts grants moderators read access to account records.
const AdminReadCanonicalEmailBlocks = "admin:read:canonical_email_blocks"
AdminReadCanonicalEmailBlocks grants moderators read access to blocked canonical email addresses.
const AdminReadDomainAllows = "admin:read:domain_allows"
AdminReadDomainAllows grants moderators read access to allowed domains.
const AdminReadDomainBlocks = "admin:read:domain_blocks"
AdminReadDomainBlocks grants moderators read access to blocked domains.
const AdminReadEmailDomainBlocks = "admin:read:email_domain_blocks"
AdminReadEmailDomainBlocks grants moderators read access to blocked email domains.
const AdminReadIPBlocks = "admin:read:ip_blocks"
AdminReadIPBlocks grants moderators read access to blocked IP ranges.
const AdminReadReports = "admin:read:reports"
AdminReadReports grants moderators read access to reports.
const AdminWrite = "admin:write"
AdminWrite grants write access to every moderation endpoint, and is the parent of every admin:write: scope.
const AdminWriteAccounts = "admin:write:accounts"
AdminWriteAccounts grants moderators the ability to act on accounts.
const AdminWriteCanonicalEmailBlocks = "admin:write:canonical_email_blocks"
AdminWriteCanonicalEmailBlocks grants moderators the ability to block and unblock canonical email addresses.
const AdminWriteDomainAllows = "admin:write:domain_allows"
AdminWriteDomainAllows grants moderators the ability to allow and un-allow domains.
const AdminWriteDomainBlocks = "admin:write:domain_blocks"
AdminWriteDomainBlocks grants moderators the ability to block and unblock domains.
const AdminWriteEmailDomainBlocks = "admin:write:email_domain_blocks"
AdminWriteEmailDomainBlocks grants moderators the ability to block and unblock email domains.
const AdminWriteIPBlocks = "admin:write:ip_blocks"
AdminWriteIPBlocks grants moderators the ability to block and unblock IP ranges.
const AdminWriteReports = "admin:write:reports"
AdminWriteReports grants moderators the ability to act on reports.
const DeleteAnnouncement_Reaction = WriteFavourites
DeleteAnnouncement_Reaction is the OAuth scope required by DELETE /api/v1/announcements/:id/reactions/:name. https://docs.joinmastodon.org/methods/announcements/#delete-reactions
const DeleteCollection = WriteCollections
https://docs.joinmastodon.org/methods/collections/#delete_collection
const DeleteCollection_Item = WriteCollections
https://docs.joinmastodon.org/methods/collections/#remove_account
const DeleteConversation = WriteConversations
DeleteConversation is the OAuth scope required by DELETE /api/v1/conversations/:id. https://docs.joinmastodon.org/methods/conversations/#delete
const DeleteDomainBlock = WriteBlocks
DeleteDomainBlock is the OAuth scope required by DELETE /api/v1/domain_blocks. https://docs.joinmastodon.org/methods/domain_blocks/#unblock
const DeleteFeaturedTag = WriteAccounts
DeleteFeaturedTag is the OAuth scope required by DELETE /api/v1/featured_tags/:id. https://docs.joinmastodon.org/methods/featured_tags/#unfeature
const DeleteFilter = WriteFilters
DeleteFilter is the OAuth scope required by DELETE /api/v2/filters/:id. https://docs.joinmastodon.org/methods/filters/#delete
const DeleteFilter_Keyword = WriteFilters
DeleteFilter_Keyword is the OAuth scope required by DELETE /api/v2/filters/keywords/:id. https://docs.joinmastodon.org/methods/filters/#keywords-delete
const DeleteFilter_Status = WriteFilters
DeleteFilter_Status is the OAuth scope required by DELETE /api/v2/filters/statuses/:id. https://docs.joinmastodon.org/methods/filters/#statuses-remove
const DeleteFilter_V1 = WriteFilters
DeleteFilter_V1 is the OAuth scope required by DELETE /api/v1/filters/:id. https://docs.joinmastodon.org/methods/filters/#delete-v1
const DeleteList = WriteLists
DeleteList is the OAuth scope required by DELETE /api/v1/lists/:id. https://docs.joinmastodon.org/methods/lists/#delete
const DeleteList_Accounts = WriteLists
DeleteList_Accounts is the OAuth scope required by DELETE /api/v1/lists/:id/accounts. https://docs.joinmastodon.org/methods/lists/#accounts-remove
const DeleteProfile_Avatar = WriteAccounts
DeleteProfile_Avatar is the OAuth scope required by DELETE /api/v1/profile/avatar. https://docs.joinmastodon.org/methods/profile/#delete-profile-avatar
const DeleteProfile_Header = WriteAccounts
DeleteProfile_Header is the OAuth scope required by DELETE /api/v1/profile/header. https://docs.joinmastodon.org/methods/profile/#delete-profile-header
const DeletePushSubscription = Push
https://docs.joinmastodon.org/methods/push/#delete
const DeleteScheduledStatus = WriteStatuses
DeleteScheduledStatus is the OAuth scope required by DELETE /api/v1/scheduled_statuses/:id. https://docs.joinmastodon.org/methods/scheduled_statuses/#cancel
const DeleteStatus = WriteStatuses
DeleteStatus is the OAuth scope required by DELETE /api/v1/statuses/:id. https://docs.joinmastodon.org/methods/statuses/#delete
const DeleteSuggestion = Read
DeleteSuggestion is the OAuth scope required by DELETE /api/v1/suggestions/:account_id. https://docs.joinmastodon.org/methods/suggestions/#remove
const GetAccount = Public
GetAccount is the OAuth scope required by GET /api/v1/accounts/:id. https://docs.joinmastodon.org/methods/accounts/#get
const GetAccount_Collections = Public
https://docs.joinmastodon.org/methods/collections/#get_collections
const GetAccount_Endorsements = ReadAccounts
GetAccount_Endorsements is the OAuth scope required by GET /api/v1/accounts/:id/endorsements. https://docs.joinmastodon.org/methods/accounts/#endorsements
const GetAccount_FamiliarFollowers = ReadFollows
GetAccount_FamiliarFollowers is the OAuth scope required by GET /api/v1/accounts/:id/familiar_followers. https://docs.joinmastodon.org/methods/accounts/#familiar_followers
const GetAccount_FeaturedTags = Private
GetAccount_FeaturedTags is the OAuth scope required by GET /api/v1/accounts/:id/featured_tags. https://docs.joinmastodon.org/methods/accounts/#featured_tags
const GetAccount_Followers = Private
GetAccount_Followers is the OAuth scope required by GET /api/v1/accounts/:id/followers. https://docs.joinmastodon.org/methods/accounts/#followers
const GetAccount_Following = Private
GetAccount_Following is the OAuth scope required by GET /api/v1/accounts/:id/following. https://docs.joinmastodon.org/methods/accounts/#following
const GetAccount_InCollections = ReadCollections
https://docs.joinmastodon.org/methods/collections/#in_collections
const GetAccount_Lists = ReadLists
GetAccount_Lists is the OAuth scope required by GET /api/v1/accounts/:id/lists. https://docs.joinmastodon.org/methods/accounts/#lists
const GetAccount_Lookup = Private
GetAccount_Lookup is the OAuth scope required by GET /api/v1/accounts/lookup. https://docs.joinmastodon.org/methods/accounts/#lookup
const GetAccount_Relationships = ReadFollows
GetAccount_Relationships is the OAuth scope required by GET /api/v1/accounts/relationships. https://docs.joinmastodon.org/methods/accounts/#relationships
const GetAccount_Search = ReadAccounts
GetAccount_Search is the OAuth scope required by GET /api/v1/accounts/search. https://docs.joinmastodon.org/methods/accounts/#search
const GetAccount_Statuses = ReadStatuses
GetAccount_Statuses is the OAuth scope required by GET /api/v1/accounts/:id/statuses. https://docs.joinmastodon.org/methods/accounts/#statuses
const GetAccount_VerifyCredentials = ReadAccounts
GetAccount_VerifyCredentials is the OAuth scope required by GET /api/v1/accounts/verify_credentials. https://docs.joinmastodon.org/methods/accounts/#verify_credentials
const GetAccounts = Public
GetAccounts is the OAuth scope required by GET /api/v1/accounts (batch lookup). https://docs.joinmastodon.org/methods/accounts/#index
const GetAnnouncements = Private
GetAnnouncements is the OAuth scope required by GET /api/v1/announcements. https://docs.joinmastodon.org/methods/announcements/#get
const GetApplication_VerifyCredentials = Private
GetApplication_VerifyCredentials is the OAuth scope required by GET /api/v1/apps/verify_credentials. https://docs.joinmastodon.org/methods/apps/#verify_credentials
const GetBlocks = ReadBlocks
GetBlocks is the OAuth scope required by GET /api/v1/blocks. https://docs.joinmastodon.org/methods/blocks/#get
const GetBookmarks = ReadBookmarks
GetBookmarks is the OAuth scope required by GET /api/v1/bookmarks. https://docs.joinmastodon.org/methods/bookmarks/#get
const GetCollection = Public
https://docs.joinmastodon.org/methods/collections/#get_collection
const GetConversations = ReadStatuses
GetConversations is the OAuth scope required by GET /api/v1/conversations. https://docs.joinmastodon.org/methods/conversations/#get
const GetCustomEmojis = Public
GetCustomEmojis is the OAuth scope required by GET /api/v1/custom_emojis. https://docs.joinmastodon.org/methods/custom_emojis/#get
const GetDirectory = Public
GetDirectory is the OAuth scope required by GET /api/v1/directory. https://docs.joinmastodon.org/methods/directory/#get
const GetDomainBlocks = ReadBlocks
GetDomainBlocks is the OAuth scope required by GET /api/v1/domain_blocks. https://docs.joinmastodon.org/methods/domain_blocks/#get
const GetEndorsements = ReadAccounts
GetEndorsements is the OAuth scope required by GET /api/v1/endorsements. https://docs.joinmastodon.org/methods/endorsements/#get
const GetFavourites = ReadFavourites
GetFavourites is the OAuth scope required by GET /api/v1/favourites. https://docs.joinmastodon.org/methods/favourites/#get
const GetFeaturedTags = ReadAccounts
GetFeaturedTags is the OAuth scope required by GET /api/v1/featured_tags. https://docs.joinmastodon.org/methods/featured_tags/#get
const GetFeaturedTags_Suggestions = ReadAccounts
GetFeaturedTags_Suggestions is the OAuth scope required by GET /api/v1/featured_tags/suggestions. https://docs.joinmastodon.org/methods/featured_tags/#suggestions
const GetFilter = ReadFilters
GetFilter is the OAuth scope required by GET /api/v2/filters/:id. https://docs.joinmastodon.org/methods/filters/#get-one
const GetFilter_Keyword = ReadFilters
GetFilter_Keyword is the OAuth scope required by GET /api/v2/filters/keywords/:id. https://docs.joinmastodon.org/methods/filters/#keywords-get-one
const GetFilter_Keywords = ReadFilters
GetFilter_Keywords is the OAuth scope required by GET /api/v2/filters/:filter_id/keywords. https://docs.joinmastodon.org/methods/filters/#keywords-get
const GetFilter_Status = ReadFilters
GetFilter_Status is the OAuth scope required by GET /api/v2/filters/statuses/:id. https://docs.joinmastodon.org/methods/filters/#statuses-get-one
const GetFilter_Statuses = ReadFilters
GetFilter_Statuses is the OAuth scope required by GET /api/v2/filters/:filter_id/statuses. https://docs.joinmastodon.org/methods/filters/#statuses-get
const GetFilter_V1 = ReadFilters
GetFilter_V1 is the OAuth scope required by GET /api/v1/filters/:id. https://docs.joinmastodon.org/methods/filters/#get-one-v1
const GetFilters = ReadFilters
GetFilters is the OAuth scope required by GET /api/v2/filters. https://docs.joinmastodon.org/methods/filters/#get
const GetFilters_V1 = ReadFilters
GetFilters_V1 is the OAuth scope required by GET /api/v1/filters. https://docs.joinmastodon.org/methods/filters/#get-v1
const GetFollowRequests = ReadFollows
GetFollowRequests is the OAuth scope required by GET /api/v1/follow_requests. https://docs.joinmastodon.org/methods/follow_requests/#get
const GetFollowedTags = ReadFollows
GetFollowedTags is the OAuth scope required by GET /api/v1/followed_tags. https://docs.joinmastodon.org/methods/followed_tags/#get
const GetGroupedNotifications = ReadNotifications
GetGroupedNotifications is the OAuth scope required by GET /api/v2/notifications. https://docs.joinmastodon.org/methods/grouped_notifications/#get-grouped
const GetGroupedNotifications_UnreadCount = ReadNotifications
GetGroupedNotifications_UnreadCount is the OAuth scope required by GET /api/v2/notifications/unread_count. https://docs.joinmastodon.org/methods/grouped_notifications/#unread-group-count
const GetInstance = Public
GetInstance is the OAuth scope required by GET /api/v2/instance. https://docs.joinmastodon.org/methods/instance/#v2
const GetInstance_Activity = Public
GetInstance_Activity is the OAuth scope required by GET /api/v1/instance/activity. https://docs.joinmastodon.org/methods/instance/#activity
const GetInstance_DomainBlocks = Public
GetInstance_DomainBlocks is the OAuth scope required by GET /api/v1/instance/domain_blocks. https://docs.joinmastodon.org/methods/instance/#domain_blocks
const GetInstance_ExtendedDescription = Public
GetInstance_ExtendedDescription is the OAuth scope required by GET /api/v1/instance/extended_description. https://docs.joinmastodon.org/methods/instance/#extended_description
const GetInstance_Peers = Public
GetInstance_Peers is the OAuth scope required by GET /api/v1/instance/peers. https://docs.joinmastodon.org/methods/instance/#peers
const GetInstance_Rules = Public
GetInstance_Rules is the OAuth scope required by GET /api/v1/instance/rules. https://docs.joinmastodon.org/methods/instance/#rules
const GetInstance_V1 = Public
GetInstance_V1 is the OAuth scope required by GET /api/v1/instance. https://docs.joinmastodon.org/methods/instance/#v1
const GetList = WriteLists
GetList is the OAuth scope required by GET /api/v1/lists/:id. https://docs.joinmastodon.org/methods/lists/#get-one
const GetList_Accounts = ReadLists
GetList_Accounts is the OAuth scope required by GET /api/v1/lists/:id/accounts. https://docs.joinmastodon.org/methods/lists/#accounts
const GetLists = ReadLists
GetLists is the OAuth scope required by GET /api/v1/lists. https://docs.joinmastodon.org/methods/lists/#get
const GetMarkers = ReadStatuses
GetMarkers is the OAuth scope required by GET /api/v1/markers. https://docs.joinmastodon.org/methods/markers/#get
const GetMedia = ReadStatuses
GetMedia is the OAuth scope required by GET /api/v1/media/:id. https://docs.joinmastodon.org/methods/media/#get
const GetMutes = ReadMutes
GetMutes is the OAuth scope required by GET /api/v1/mutes. https://docs.joinmastodon.org/methods/mutes/#get
const GetNotification = ReadNotifications
GetNotification is the OAuth scope required by GET /api/v1/notifications/:id. https://docs.joinmastodon.org/methods/notifications/#get-one
const GetNotificationGroup = ReadNotifications
GetNotificationGroup is the OAuth scope required by GET /api/v2/notifications/:group_key. https://docs.joinmastodon.org/methods/grouped_notifications/#get-notification-group
const GetNotificationPolicy = ReadNotifications
https://docs.joinmastodon.org/methods/notifications/#get-policy
const GetNotificationRequest = ReadNotifications
https://docs.joinmastodon.org/methods/notifications/#get-one-request
const GetNotificationRequests = ReadNotifications
https://docs.joinmastodon.org/methods/notifications/#get-requests
const GetNotificationRequests_Merged = ReadNotifications
https://docs.joinmastodon.org/methods/notifications/#requests-merged
const GetNotifications = ReadNotifications
GetNotifications is the OAuth scope required by GET /api/v1/notifications. https://docs.joinmastodon.org/methods/notifications/#get
const GetNotifications_UnreadCount = ReadNotifications
https://docs.joinmastodon.org/methods/notifications/#unread-count
const GetOAuth_Authorize = Public
GetOAuth_Authorize is the OAuth scope required by GET /oauth/authorize. https://docs.joinmastodon.org/methods/oauth/#authorize
const GetOEmbed = Public
GetOEmbed is the OAuth scope required by GET /api/oembed. https://docs.joinmastodon.org/methods/oembed/#get
const GetPoll = ReadStatuses
GetPoll is the OAuth scope required by GET /api/v1/polls/:id. https://docs.joinmastodon.org/methods/polls/#get
const GetPreferences = ReadAccounts
GetPreferences is the OAuth scope required by GET /api/v1/preferences. https://docs.joinmastodon.org/methods/preferences/#get
const GetPushSubscription = Push
https://docs.joinmastodon.org/methods/push/#get
const GetScheduledStatus = ReadStatuses
GetScheduledStatus is the OAuth scope required by GET /api/v1/scheduled_statuses/:id. https://docs.joinmastodon.org/methods/scheduled_statuses/#get-one
const GetScheduledStatuses = ReadStatuses
GetScheduledStatuses is the OAuth scope required by GET /api/v1/scheduled_statuses. https://docs.joinmastodon.org/methods/scheduled_statuses/#get
const GetSearch = ReadSearch
GetSearch is the OAuth scope required by GET /api/v2/search. https://docs.joinmastodon.org/methods/search/#v2
const GetStatus = ReadStatuses
GetStatus is the OAuth scope required by GET /api/v1/statuses/:id. https://docs.joinmastodon.org/methods/statuses/#get
const GetStatus_Context = ReadStatuses
GetStatus_Context is the OAuth scope required by GET /api/v1/statuses/:id/context. https://docs.joinmastodon.org/methods/statuses/#context
const GetStatus_FavouritedBy = ReadStatuses
GetStatus_FavouritedBy is the OAuth scope required by GET /api/v1/statuses/:id/favourited_by. https://docs.joinmastodon.org/methods/statuses/#favourited_by
const GetStatus_History = ReadStatuses
GetStatus_History is the OAuth scope required by GET /api/v1/statuses/:id/history. https://docs.joinmastodon.org/methods/statuses/#history
const GetStatus_RebloggedBy = ReadStatuses
GetStatus_RebloggedBy is the OAuth scope required by GET /api/v1/statuses/:id/reblogged_by. https://docs.joinmastodon.org/methods/statuses/#reblogged_by
const GetStatus_Source = ReadStatuses
GetStatus_Source is the OAuth scope required by GET /api/v1/statuses/:id/source. https://docs.joinmastodon.org/methods/statuses/#source
const GetSuggestions = Read
GetSuggestions is the OAuth scope required by GET /api/v2/suggestions. https://docs.joinmastodon.org/methods/suggestions/#v2
const GetTag = ReadStatuses
GetTag is the OAuth scope required by GET /api/v1/tags/:id. https://docs.joinmastodon.org/methods/tags/#get
const GetTimeline_Hashtag = ReadStatuses
GetTimeline_Hashtag is the OAuth scope required by GET /api/v1/timelines/tag/:hashtag. https://docs.joinmastodon.org/methods/timelines/#tag
const GetTimeline_Home = ReadStatuses
GetTimeline_Home is the OAuth scope required by GET /api/v1/timelines/home. https://docs.joinmastodon.org/methods/timelines/#home
const GetTimeline_List = ReadStatuses
GetTimeline_List is the OAuth scope required by GET /api/v1/timelines/list/:list_id. https://docs.joinmastodon.org/methods/timelines/#list
const GetTimeline_Public = ReadStatuses
GetTimeline_Public is the OAuth scope required by GET /api/v1/timelines/public. https://docs.joinmastodon.org/methods/timelines/#public
const GetTrends = Public
GetTrends is the OAuth scope required by GET /api/v1/trends. https://docs.joinmastodon.org/methods/trends/#tags
const GetTrends_Links = Public
GetTrends_Links is the OAuth scope required by GET /api/v1/trends/links. https://docs.joinmastodon.org/methods/trends/#links
const GetTrends_Statuses = Public
GetTrends_Statuses is the OAuth scope required by GET /api/v1/trends/statuses. https://docs.joinmastodon.org/methods/trends/#statuses
const PatchAccount_UpdateCredentials = WriteAccounts
PatchAccount_UpdateCredentials is the OAuth scope required by PATCH /api/v1/accounts/update_credentials. https://docs.joinmastodon.org/methods/accounts/#update_credentials
const PatchCollection = WriteCollections
https://docs.joinmastodon.org/methods/collections/#update_collection
const PatchNotificationPolicy = WriteNotifications
https://docs.joinmastodon.org/methods/notifications/#update-policy
const PostAccount = WriteAccounts
PostAccount is the OAuth scope required by POST /api/v1/accounts. https://docs.joinmastodon.org/methods/accounts/#create
const PostAccount_Block = WriteBlocks
PostAccount_Block is the OAuth scope required by POST /api/v1/accounts/:id/block. https://docs.joinmastodon.org/methods/accounts/#block
const PostAccount_Follow = WriteFollows
PostAccount_Follow is the OAuth scope required by POST /api/v1/accounts/:id/follow. https://docs.joinmastodon.org/methods/accounts/#follow
const PostAccount_Mute = WriteMutes
PostAccount_Mute is the OAuth scope required by POST /api/v1/accounts/:id/mute. https://docs.joinmastodon.org/methods/accounts/#mute
const PostAccount_Note = WriteAccounts
PostAccount_Note is the OAuth scope required by POST /api/v1/accounts/:id/note. https://docs.joinmastodon.org/methods/accounts/#note
const PostAccount_Pin = WriteAccounts
PostAccount_Pin is the OAuth scope required by POST /api/v1/accounts/:id/pin. https://docs.joinmastodon.org/methods/accounts/#pin
const PostAccount_RemoveFromFollowers = WriteFollows
PostAccount_RemoveFromFollowers is the OAuth scope required by POST /api/v1/accounts/:id/remove_from_followers. https://docs.joinmastodon.org/methods/accounts/#remove_from_followers
const PostAccount_Unblock = WriteBlocks
PostAccount_Unblock is the OAuth scope required by POST /api/v1/accounts/:id/unblock. https://docs.joinmastodon.org/methods/accounts/#unblock
const PostAccount_Unfollow = WriteFollows
PostAccount_Unfollow is the OAuth scope required by POST /api/v1/accounts/:id/unfollow. https://docs.joinmastodon.org/methods/accounts/#unfollow
const PostAccount_Unmute = WriteMutes
PostAccount_Unmute is the OAuth scope required by POST /api/v1/accounts/:id/unmute. https://docs.joinmastodon.org/methods/accounts/#unmute
const PostAccount_Unpin = WriteAccounts
PostAccount_Unpin is the OAuth scope required by POST /api/v1/accounts/:id/unpin. https://docs.joinmastodon.org/methods/accounts/#unpin
const PostAnnouncement_Dismiss = WriteAccounts
PostAnnouncement_Dismiss is the OAuth scope required by POST /api/v1/announcements/:id/dismiss. https://docs.joinmastodon.org/methods/announcements/#dismiss
const PostApplication = Public
PostApplication is the OAuth scope required by POST /api/v1/apps. https://docs.joinmastodon.org/methods/apps/#create
const PostCollection = WriteCollections
https://docs.joinmastodon.org/methods/collections/#create
const PostCollection_Item = WriteCollections
https://docs.joinmastodon.org/methods/collections/#add_account
const PostCollection_Item_Revoke = WriteCollections
https://docs.joinmastodon.org/methods/collections/#revoke_item
const PostConversationRead = WriteConversations
PostConversationRead is the OAuth scope required by POST /api/v1/conversations/:id/read. https://docs.joinmastodon.org/methods/conversations/#read
const PostDomainBlock = WriteBlocks
PostDomainBlock is the OAuth scope required by POST /api/v1/domain_blocks. https://docs.joinmastodon.org/methods/domain_blocks/#block
const PostEmailConfirmation = Private
PostEmailConfirmation is the OAuth scope required by POST /api/v1/email/confirmation. https://docs.joinmastodon.org/methods/emails/#confirmation
const PostFeaturedTag = WriteAccounts
PostFeaturedTag is the OAuth scope required by POST /api/v1/featured_tags. https://docs.joinmastodon.org/methods/featured_tags/#feature
const PostFilter = WriteFilters
PostFilter is the OAuth scope required by POST /api/v2/filters. https://docs.joinmastodon.org/methods/filters/#create
const PostFilter_Keyword = WriteFilters
PostFilter_Keyword is the OAuth scope required by POST /api/v2/filters/:filter_id/keywords. https://docs.joinmastodon.org/methods/filters/#keywords-create
const PostFilter_Status = WriteFilters
PostFilter_Status is the OAuth scope required by POST /api/v2/filters/:filter_id/statuses. https://docs.joinmastodon.org/methods/filters/#statuses-add
const PostFilter_V1 = WriteFilters
PostFilter_V1 is the OAuth scope required by POST /api/v1/filters. https://docs.joinmastodon.org/methods/filters/#create-v1
const PostFollowRequest_Authorize = WriteFollows
PostFollowRequest_Authorize is the OAuth scope required by POST /api/v1/follow_requests/:account_id/authorize. https://docs.joinmastodon.org/methods/follow_requests/#accept
const PostFollowRequest_Reject = WriteFollows
PostFollowRequest_Reject is the OAuth scope required by POST /api/v1/follow_requests/:account_id/reject. https://docs.joinmastodon.org/methods/follow_requests/#reject
const PostGroupedNotifications_Clear = WriteNotifications
PostGroupedNotifications_Clear is the OAuth scope required by POST /api/v2/notifications/clear. https://docs.joinmastodon.org/methods/notifications/#clear
const PostList = WriteLists
PostList is the OAuth scope required by POST /api/v1/lists. https://docs.joinmastodon.org/methods/lists/#create
const PostList_Accounts = WriteLists
PostList_Accounts is the OAuth scope required by POST /api/v1/lists/:id/accounts. https://docs.joinmastodon.org/methods/lists/#accounts-add
const PostMarker = WriteStatuses
PostMarker is the OAuth scope required by POST /api/v1/markers. https://docs.joinmastodon.org/methods/markers/#create
const PostMedia = WriteMedia
PostMedia is the OAuth scope required by POST /api/v2/media. https://docs.joinmastodon.org/methods/media/#v2
const PostNotificationGroup_Dismiss = WriteNotifications
PostNotificationGroup_Dismiss is the OAuth scope required by POST /api/v2/notifications/:group_key/dismiss. https://docs.joinmastodon.org/methods/grouped_notifications/#dismiss-group
const PostNotificationRequest_Accept = WriteNotifications
https://docs.joinmastodon.org/methods/notifications/#accept-request
const PostNotificationRequest_Dismiss = WriteNotifications
https://docs.joinmastodon.org/methods/notifications/#dismiss-request
const PostNotificationRequests_Accept = WriteNotifications
https://docs.joinmastodon.org/methods/notifications/#accept-multiple-requests
const PostNotificationRequests_Dismiss = WriteNotifications
https://docs.joinmastodon.org/methods/notifications/#dismiss-multiple-requests
const PostNotification_Dismiss = WriteNotifications
PostNotification_Dismiss is the OAuth scope required by POST /api/v1/notifications/dismiss. https://docs.joinmastodon.org/methods/notifications/#dismiss
const PostNotifications_Clear = WriteNotifications
PostNotifications_Clear is the OAuth scope required by POST /api/v1/notifications/clear. https://docs.joinmastodon.org/methods/notifications/#clear
const PostOAuth_Revoke = Public
PostOAuth_Revoke is the OAuth scope required by POST /oauth/revoke. https://docs.joinmastodon.org/methods/oauth/#revoke
const PostOAuth_Token = Public
PostOAuth_Token is the OAuth scope required by POST /oauth/token. https://docs.joinmastodon.org/methods/oauth/#token
const PostPoll_Votes = WriteStatuses
PostPoll_Votes is the OAuth scope required by POST /api/v1/polls/:id/votes. https://docs.joinmastodon.org/methods/polls/#vote
const PostPushSubscription = Push
***************************************** * Push API Methods * Subscribe to and receive push notifications when a server-side * notification is received, via the Web Push API * https://docs.joinmastodon.org/methods/push/ ***************************************** https://docs.joinmastodon.org/methods/push/#create
const PostReport = WriteReports
PostReport is the OAuth scope required by POST /api/v1/reports. https://docs.joinmastodon.org/methods/reports/#post
const PostStatus = WriteStatuses
PostStatus is the OAuth scope required by POST /api/v1/statuses. https://docs.joinmastodon.org/methods/statuses/#create
const PostStatus_Bookmark = WriteStatuses
PostStatus_Bookmark is the OAuth scope required by POST /api/v1/statuses/:id/bookmark. https://docs.joinmastodon.org/methods/statuses/#bookmark
const PostStatus_Favourite = WriteStatuses
PostStatus_Favourite is the OAuth scope required by POST /api/v1/statuses/:id/favourite. https://docs.joinmastodon.org/methods/statuses/#favourite
const PostStatus_Mute = WriteStatuses
PostStatus_Mute is the OAuth scope required by POST /api/v1/statuses/:id/mute. https://docs.joinmastodon.org/methods/statuses/#mute
const PostStatus_Pin = WriteStatuses
PostStatus_Pin is the OAuth scope required by POST /api/v1/statuses/:id/pin. https://docs.joinmastodon.org/methods/statuses/#pin
const PostStatus_Reblog = WriteStatuses
PostStatus_Reblog is the OAuth scope required by POST /api/v1/statuses/:id/reblog. https://docs.joinmastodon.org/methods/statuses/#reblog
const PostStatus_Translate = WriteStatuses
PostStatus_Translate is the OAuth scope required by POST /api/v1/statuses/:id/translate. https://docs.joinmastodon.org/methods/statuses/#translate
const PostStatus_Unbookmark = WriteStatuses
PostStatus_Unbookmark is the OAuth scope required by POST /api/v1/statuses/:id/unbookmark. https://docs.joinmastodon.org/methods/statuses/#unbookmark
const PostStatus_Unfavourite = WriteStatuses
PostStatus_Unfavourite is the OAuth scope required by POST /api/v1/statuses/:id/unfavourite. https://docs.joinmastodon.org/methods/statuses/#unfavourite
const PostStatus_Unmute = WriteStatuses
PostStatus_Unmute is the OAuth scope required by POST /api/v1/statuses/:id/unmute. https://docs.joinmastodon.org/methods/statuses/#unmute
const PostStatus_Unpin = WriteStatuses
PostStatus_Unpin is the OAuth scope required by POST /api/v1/statuses/:id/unpin. https://docs.joinmastodon.org/methods/statuses/#unpin
const PostStatus_Unreblog = WriteStatuses
PostStatus_Unreblog is the OAuth scope required by POST /api/v1/statuses/:id/unreblog. https://docs.joinmastodon.org/methods/statuses/#unreblog
const PostTag_Follow = WriteFollows
PostTag_Follow is the OAuth scope required by POST /api/v1/tags/:id/follow. https://docs.joinmastodon.org/methods/tags/#follow
const PostTag_Unfollow = WriteFollows
PostTag_Unfollow is the OAuth scope required by POST /api/v1/tags/:id/unfollow. https://docs.joinmastodon.org/methods/tags/#unfollow
const Private = "*"
Private is not defined by the Mastodon API, but is used by this library to indicate a private route that requires an App token, but does not require any specific scope.
const Public = ""
Public is not defined by the Mastodon API, but is used by this library to indicate a public route that does not require an App token.
const Push = "push"
Push grants access to the Web Push subscription endpoints. https://docs.joinmastodon.org/api/oauth-scopes/#push
const PutAnnouncement_Reaction = WriteFavourites
PutAnnouncement_Reaction is the OAuth scope required by PUT /api/v1/announcements/:id/reactions/:name. https://docs.joinmastodon.org/methods/announcements/#put-reactions
const PutFilter = WriteFilters
PutFilter is the OAuth scope required by PUT /api/v2/filters/:id. https://docs.joinmastodon.org/methods/filters/#update
const PutFilter_Keyword = WriteFilters
PutFilter_Keyword is the OAuth scope required by PUT /api/v2/filters/keywords/:id. https://docs.joinmastodon.org/methods/filters/#keywords-update
const PutFilter_V1 = WriteFilters
PutFilter_V1 is the OAuth scope required by PUT /api/v1/filters/:id. https://docs.joinmastodon.org/methods/filters/#update-v1
const PutList = WriteLists
PutList is the OAuth scope required by PUT /api/v1/lists/:id. https://docs.joinmastodon.org/methods/lists/#update
const PutMedia = WriteMedia
PutMedia is the OAuth scope required by PUT /api/v1/media/:id. https://docs.joinmastodon.org/methods/media/#update
const PutPushSubscription = Push
https://docs.joinmastodon.org/methods/push/#update
const PutScheduledStatus = WriteStatuses
PutScheduledStatus is the OAuth scope required by PUT /api/v1/scheduled_statuses/:id. https://docs.joinmastodon.org/methods/scheduled_statuses/#update
const PutStatus = WriteStatuses
PutStatus is the OAuth scope required by PUT /api/v1/statuses/:id. https://docs.joinmastodon.org/methods/statuses/#edit
const Read = "read"
Read grants read access to every part of the account, and is the parent of every read: scope. https://docs.joinmastodon.org/api/oauth-scopes/#read
const ReadAccounts = "read:accounts"
ReadAccounts grants read access to profiles, preferences, endorsements, and featured tags.
const ReadBlocks = "read:blocks"
ReadBlocks grants read access to blocked accounts and blocked domains.
const ReadBookmarks = "read:bookmarks"
ReadBookmarks grants read access to bookmarked statuses.
const ReadCollections = "read:collections"
Grants access to view a user's Collections
const ReadFavourites = "read:favourites"
ReadFavourites grants read access to favourited statuses.
const ReadFilters = "read:filters"
ReadFilters grants read access to keyword and status filters.
const ReadFollows = "read:follows"
ReadFollows grants read access to follows, follow requests, and followed tags.
const ReadLists = "read:lists"
ReadLists grants read access to lists and their members.
const ReadMutes = "read:mutes"
ReadMutes grants read access to muted accounts.
const ReadNotifications = "read:notifications"
ReadNotifications grants read access to notifications.
const ReadSearch = "read:search"
ReadSearch grants access to search.
const ReadStatuses = "read:statuses"
ReadStatuses grants read access to statuses, timelines, conversations, polls, and markers.
const Write = "write"
Write grants write access to every part of the account, and is the parent of every write: scope. https://docs.joinmastodon.org/api/oauth-scopes/#write
const WriteAccounts = "write:accounts"
WriteAccounts grants write access to the profile, including avatar and header images.
const WriteBlocks = "write:blocks"
WriteBlocks grants the ability to block and unblock accounts and domains.
const WriteBookmarks = "write:bookmarks"
WriteBookmarks grants the ability to bookmark and un-bookmark statuses.
const WriteCollections = "write:collections"
Grants access to create and manage a user's Collections
const WriteConversations = "write:conversations"
WriteConversations grants the ability to delete conversations and mark them read.
const WriteFavourites = "write:favourites"
WriteFavourites grants the ability to favourite statuses and react to announcements.
const WriteFilters = "write:filters"
WriteFilters grants the ability to create, change, and delete filters.
const WriteFollows = "write:follows"
WriteFollows grants the ability to follow, unfollow, and answer follow requests.
const WriteLists = "write:lists"
WriteLists grants the ability to create, change, and delete lists and their members.
const WriteMedia = "write:media"
WriteMedia grants the ability to upload media attachments.
const WriteMutes = "write:mutes"
WriteMutes grants the ability to mute and unmute accounts and conversations.
const WriteNotifications = "write:notifications"
WriteNotifications grants the ability to dismiss and clear notifications.
const WriteReports = "write:reports"
WriteReports grants the ability to report accounts and statuses.
const WriteStatuses = "write:statuses"
WriteStatuses grants the ability to publish, edit, and delete statuses.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files
¶
- accounts.go
- admin-.go
- admin-accounts.go
- admin-canonical-email-blocks.go
- admin-dimensions.go
- admin-domain-allows.go
- admin-domain-blocks.go
- admin-email-blocks.go
- admin-ip-blocks.go
- admin-measures.go
- admin-reports.go
- admin-retention.go
- admin-trends.go
- announcements.go
- apps.go
- blocks.go
- bookmarks.go
- collection.go
- conversations.go
- custom-emojis.go
- directory.go
- domain-blocks.go
- emails.go
- endorsements.go
- favourites.go
- featured-tags.go
- filters.go
- follow-requests.go
- followed-tags.go
- grouped-notifications.go
- instance.go
- lists.go
- markers.go
- media.go
- mutes.go
- notifications.go
- oauth.go
- oembed.go
- polls.go
- preferences.go
- profile.go
- push.go
- reports.go
- scheduled-statuses.go
- scope.go
- search.go
- statuses.go
- streaming.go
- suggestions.go
- tags.go
- timelines.go
- trends.go