Account
account.banDomain
Blocks a remote server on behalf of the current user.
account.banUser
Blocks a user on behalf of the current user.
account.getAppPermissions
Returns the list of permissions granted to the access token.
account.getBannedDomains
Returns the list of remote server domains blocked by the current user.
account.getBannedUsers
Returns the list of users blocked by the current user.
account.getCounters
Returns how many of each type of unread items the current user has.
account.setOffline
Sets the current user's presence status to "offline", even if the 5-minute timeout hasn't expired yet.
account.setOnline
Sets the current user's presence status to "online" for 5 minutes.
account.unbanDomain
Unlocks a remote server on behalf of the current user.
account.unbanUser
Unblocks a user on behalf of the current user.
Board
board.closeTopic
Closes a topic so that no more comments could be posted.
board.createComment
Creates a new comment in a topic.
board.createTopic
Creates a new topic in a group.
board.deleteTopic
Deletes a topic.
board.editComment
Edits a comment in a topic.
board.editTopic
Edits the title of a topic.
board.getCommentEditSource
Returns the source of the text and attachments of a comment, as submitted when creating it, so they could be used for editing.
board.getComments
Returns comments in a board topic.
board.getTopics
Returns the list of topics in a group's discussion board.
board.getTopicsById
Returns discussion board topics by their identifiers.
board.openTopic
Reopens a previously closed topic.
board.pinTopic
Pins a topic so it's always displayed at the top of the discussion board.
board.unpinTopic
Unpins a previously pinned topic.
Execute
execute
Runs your JavaScript-like script on the server to make multiple API calls and post-process their results.
Favorites
fave.addGroup
Adds a group to the current user's bookmarks.
fave.addUser
Adds a user to the current user's bookmarks.
fave.getGroups
Returns the current user's bookmarked groups and events.
fave.getPhotos
Returns the list of photos liked by the current user.
fave.getPosts
Returns the list of posts liked by the current user.
fave.getUsers
Returns the current user's bookmarked users.
fave.removeGroup
Removes a group from the current user's bookmarks.
fave.removeUser
Removes a user from the current user's bookmarks.
Friends
friends.add
Sends a friend request, accepts an incoming friend request, or follows a user.
friends.addList
Creates a private friend list.
friends.areFriends
Returns information about friendship states and friend requests related to the specified users.
friends.delete
Unfriends or unfollows a user. If there's an outgoing friend request, cancels it. If there's an incoming friend request, rejects it, same as the "leave as a follower" button on the web.
friends.deleteList
Deletes a friend list.
friends.edit
Changes which lists a friend is included in.
friends.editList
Updates an existing friend list.
friends.get
Returns the friend list of a user.
friends.getLists
Returns friend lists.
friends.getMutual
Returns the list of mutual friends between two users.
friends.getOnline
Returns the friends of a user that are online right now.
friends.getRequests
Returns the current user's incoming friend requests.
Groups
groups.acceptUser
Accepts a pending request to join a group.
groups.banDomain
Blocks a remote server in a group.
groups.banUser
Blocks a user from participating in a group.
groups.get
Returns the list of groups or events in which a user is a member.
groups.getBannedDomains
Returns the list of remote server domains blocked in a group.
groups.getBannedUsers
Returns the list of users blocked in a group.
groups.getById
Returns information about groups.
groups.getInvitedUsers
Returns the list of users who have a pending invitation to a group.
groups.getInvites
Returns the group invitations for the current user.
groups.getMembers
Returns the list of group members.
groups.getRequests
Returns the list of users who requested to join a closed group.
groups.isMember
Checks whether a user is a member of a group or an event.
groups.join
Joins a group.
groups.leave
Leaves a group or rejects an invitation.
groups.removeUser
Removes a user from a group, rejects a pending join request, or cancels an invitation.
groups.search
Searches groups or events.
groups.unbanDomain
Unblocks a previously blocked remote server in a group.
groups.unbanUser
Unblocks a previously blocked user in a group.
Likes
likes.add
Likes an object on behalf of the current user.
likes.delete
Undoes the like of an object on behalf of the current user.
likes.getList
Returns the list of users who like an object.
likes.isLiked
Checks whether a user likes an object.
Messages
messages.delete
Deletes a message.
messages.get
Returns the current user's incoming or outgoing private messages.
messages.getById
Returns messages by their identifiers.
messages.getHistory
Returns the conversation history with a specified user.
messages.markAsRead
Marks a message as read.
messages.restore
Restores a previously deleted message.
messages.send
Sends a new message.
Newsfeed
newsfeed.addBan
Hides a user's updates from the current user's news feed.
newsfeed.addFilter
Creates a new word filter for the current user's news feeds.
newsfeed.deleteBan
Allows previously hidden user to appear again in the current user's news feed.
newsfeed.deleteFilter
Deletes a word filter.
newsfeed.editFilter
Updates a word filter.
newsfeed.get
Returns the current user's followees' updates (and their own posts).
newsfeed.getBanned
Returns the list of users whose updates are hidden from the current user's news feed.
newsfeed.getComments
Returns comment threads that the current user has participated in.
newsfeed.getFilters
Returns the word filters the current user has set up for their news feeds.
newsfeed.getGroups
Returns updates from the current user's groups.
Notifications
notifications.get
Returns the current user's notifications.
notifications.markAsViewed
Resets the unread notifications counter for the current user.
Photos
board.deleteComment
Deletes a comment in a topic.
photos.confirmTag
Confirms the current user's tag on a photo.
photos.copy
Saves a copy of a photo to the current user's "Saved photos" album.
photos.createAlbum
Creates a new photo album.
photos.createComment
Creates a new comment on a photo.
photos.delete
Deletes a photo.
photos.deleteAlbum
Deletes a photo album.
photos.deleteComment
Deletes a comment on a photo.
photos.edit
Updates the caption of a photo.
photos.editAlbum
Updates a photo album.
photos.editComment
Edits a comment on a photo.
photos.get
Returns photos from an album.
photos.getAlbums
Returns a user's or group's photo albums.
photos.getAlbumsById
Returns photo albums.
photos.getAll
Returns all photos uploaded by a user or in a group.
photos.getAttachmentUploadServer
Get the information required for uploading an image to be attached to a wall post, comment, or message.
photos.getById
Returns photos.
photos.getCommentEditSource
Returns the source of the text and attachments of a comment, as submitted when creating it, so they could be used for editing.
photos.getComments
Returns comments on a photo.
photos.getFeedEntry
Returns a complete list of photos for a newsfeed entry.
photos.getNewTags
Returns photos with unconfirmed tags of the current user.
photos.getOwnerPhotoUploadServer
Returns a URL for uploading a new profile picture for the current user or a group they manage.
photos.getTags
Returns tags for a photo.
photos.getUploadServer
Returns a URL for uploading a new photo to a photo album.
photos.getUserPhotos
Returns photos that a user is tagged in.
photos.makeCover
Sets a photo as the album cover.
photos.putTag
Creates a new tag on a photo.
photos.removeTag
Deletes a tag from a photo.
photos.save
Saves a newly uploaded photo to an album.
photos.saveOwnerPhoto
Saves a newly uploaded profile picture.
Polls
polls.addVote
Votes in a poll on behalf of the current user.
polls.create
Creates a poll to later attach to a post.
polls.getById
Returns a poll.
polls.getVoters
Returns a list of users who voted for a specific option in a poll.
Server
server.getInfo
Returns information about this server.
server.getRestrictedServers
Returns the list of servers for which there are federation restrictions.
Status
status.get
Returns a user's or group's status text.
status.set
Updates the current user's or their managed group's status.
Users
users.get
Returns information about users.
users.getFollowers
Returns the list of a user's followers.
users.getSubscriptions
Returns the list of users followed by a user.
users.search
Returns a list of users matching search criteria.
Utils
utils.getServerTime
Returns the current time.
utils.loadRemoteObject
Loads an object from another fediverse server.
utils.resolveScreenName
Returns the user, group, or app ID by its screen name (username).
Wall
wall.createComment
Creates a new comment on a wall post.
wall.delete
Deletes a wall post or comment.
wall.edit
Edits a wall post or comment.
wall.get
Returns the posts on a user's or group's wall.
wall.getById
Returns wall posts by their IDs.
wall.getComments
Returns comments on a wall post.
wall.getEditSource
Returns the source of the text and attachments of a post or a comment, as submitted when creating it, so they could be used for editing.
wall.getReposts
Returns the list of reposts for a wall post or comment.
wall.pin
Pins a post so it appears at the top of the owner's wall.
wall.post
Creates a new wall post.
wall.repost
Reposts a post or a comment to the current user's wall.
wall.unpin
Unpins a previously pinned wall post.