Target account ID. Or follow request ID in Friendica.
Relationship.
Add accounts to a list.
Target list ID.
Array of account IDs to add to the list.
Add a reaction to an announcement.
The ID of the Announcement in the database.
Unicode emoji, or the shortcode of a custom emoji.
lock the given account. Clients should filter statuses from this account if received.
The account ID.
Relationship
Bookmark a status
The target status id.
Status.
Cancel all requests in this instance.
void
Cancel a scheduled status.
Target scheduled status ID.
Create an application.
your application's name
Form Data
React to a post with a unicode emoji.
Target status ID.
Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
Status.
Promote a hashtag on your profile.
Target hashtag name.
FeaturedTag.
Create a filter.
Text to be filtered.
Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
Optional
options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }Optional
expires_in?: stringISO 8601 Datetime for when the filter expires.
Optional
irreversible?: booleanShould the server irreversibly drop matching entities from home and notifications?
Optional
whole_word?: booleanConsider word boundaries?
Filter
Remove accounts from list.
Target list ID.
Array of account IDs to add to the list.
Remove a reaction to a post with a unicode emoji.
Target status ID.
A unicode emoji you want to remove.
Status.
Stop promoting a hashtag on your profile.
Target featured tag id.
Empty
Remove a filter.
The filter ID.
Removed filter.
Remove current subscription.
Delete one of your own statuses.
The target status id.
Status
Dismiss an announcement.
The ID of the Announcement in the database.
Dismiss a single notification.
Target notification ID.
Dismiss all notifications.
Edit a given status to change its text, sensitivity, media attachments, or poll. Note that editing a poll’s options will reset the votes.
The target status id.
Optional
media_ids?: string[]Array of Attachment ids.
Optional
poll?: {Poll object.
Optional
sensitive?: booleanMark status and attached media as sensitive?
Optional
spoiler_text?: stringText to be shown as a warning or subject before the actual content.
Optional
status?: stringText context of status.
Status
Favourite a status.
The target status id.
Status.
Fetch OAuth access token. Get an access token based client_id and client_secret and authorization code.
will be generated by #createApp or #registerApp
will be generated by #createApp or #registerApp
will be generated by the link of #generateAuthUrl or #registerApp
Optional
redirect_uri: stringmust be the same uri as the time when you register your OAuth application
Follow the given account. Can also be used to update whether to show reblogs or enable notifications.
The account ID.
Optional
options: { reblog?: boolean }Relationship
Follow a hashtag. Posts containing a followed hashtag will be inserted into your home timeline.
Target hashtag id.
Tag
View information about a profile.
The account ID.
An account.
Favourites timeline of any user.
Target account ID.
Optional
options: { limit?: number; max_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return.
Optional
max_id?: stringReturn results order than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
Accounts which follow the given account, if network is not hidden by the account owner.
The account ID.
Optional
options: {Optional
get_all?: booleanOptional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
since_id?: stringReturn results newer than ID.
Optional
sleep_ms?: numberThe array of accounts.
Accounts which the given account is following, if network is not hidden by the account owner.
The account ID.
Optional
options: {Optional
get_all?: booleanOptional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
since_id?: stringReturn results newer than ID.
Optional
sleep_ms?: numberThe array of accounts.
User lists that you have added this account to.
The account ID.
The array of lists.
View accounts in a list.
Target list ID.
Optional
options: { limit?: number; max_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return.
Optional
max_id?: stringReturn results older than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of accounts.
Statuses posted to the given account.
The account ID.
Optional
options: {Optional
exclude_reblogs?: booleanReturn statuses which exclude reblogs.
Optional
exclude_replies?: booleanReturn statuses which exclude replies.
Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results newer than ID.
Optional
only_media?: booleanShow only statuses with media attached? Defaults to false.
Optional
only_public?: booleanReturn statuses with public visibility only.
Optional
pinned?: booleanReturn statuses which include pinned statuses.
Optional
since_id?: stringReturn results newer than ID but starting with most recent.
Account's statuses.
View blocked users.
Optional
options: { limit?: number; max_id?: string; min_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Array of accounts.
Statuses the user has bookmarked.
Optional
options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
View all conversations.
Optional
options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
View domains the user has blocked.
Optional
options: { limit?: number; max_id?: string; min_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Array of domain name.
Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji.
Target status ID.
A unicode emoji.
Reaction.
Get an object of emoji to account mappings with accounts that reacted to the post.
Target status ID.
Array of reaction.
Accounts that the user is currently featuring on their profile.
Optional
options: { limit?: number; max_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of accounts.
Statuses the user has favourited.
Optional
options: { limit?: number; max_id?: string; min_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Array of statuses.
List all hashtags featured on your profile.
Array of featured tag.
Get pending follow requests.
Optional
limit: numberMaximum number of results.
Array of account or follow request.
View home timeline.
Optional
options: {Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
local?: booleanShow only local statuses? Defaults to false.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
Returns an IdentityProof.
The account ID.
Array of IdentityProof
View server information.
Weekly activity.
View profile directory.
Optional
options: { limit?: number; local?: boolean; offset?: number; order?: "active" | "new" }Optional
limit?: numberHow many accounts to load. Default 40.
Optional
local?: booleanOnly return local accounts.
Optional
offset?: numberHow many accounts to skip before returning results. Default 0.
Optional
order?: "active" | "new"Order of results.
Array of accounts.
List of connected domains.
View trending tags.
Optional
limit: null | numberMaximum number of results to return. Defaults to 10.
View list timeline.
Local ID of the list in the database.
Optional
options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
View local timeline.
Optional
options: {Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
only_media?: booleanShow only statuses with media attached? Defaults to false.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
Get saved timeline positions.
Marker or empty object.
Get media attachment.
Target media ID.
Attachment
Accounts the user has muted.
Optional
options: { limit?: number; max_id?: string; min_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Array of accounts.
Get a single notification.
Target notification ID.
Notification.
Get all notifications.
Optional
options: {Optional
account_id?: stringReturn only notifications received from this account.
Optional
exclude_types?: string[]Array of types to exclude.
Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of notifications.
Get preferences defined by the user in their account settings.
Preferences.
View public timeline.
Optional
options: {Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
only_media?: booleanShow only statuses with media attached? Defaults to false.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
Find out whether a given account is followed, blocked, muted, etc.
The account ID.
Relationship
Find out whether given accounts are followed, blocked, muted, etc.
Array of account IDs.
Array of Relationship.
View a single scheduled status.
Target status ID.
ScheduledStatus.
View scheduled statuses.
Optional
options: { limit?: number; max_id?: string; min_id?: string; since_id?: string }Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
since_id?: stringReturn results newer than ID.
Array of scheduled statuses.
Obtain information about a status.
The target status id.
Status
Get parent and child statuses in context. View statuses above and below this status in the thread.
The target status id.
Optional
options: { limit?: number; max_id?: string; since_id?: string }Context
See who favourited a status
The target status id.
Array of accounts.
See who boosted a status.
The target status id.
Array of accounts.
View status source. Obtain the source properties for a status so that it can be edited.
The target status id.
StatusSource
Accounts the user has had past positive interactions with, but is not yet following.
Optional
limit: numberMaximum number of results.
Array of accounts.
Show a hashtag and its associated information
Target hashtag id.
Tag
View hashtag timeline.
Content of a #hashtag, not including # symbol.
Optional
options: {Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
local?: booleanShow only local statuses? Defaults to false.
Optional
max_id?: stringReturn results older than ID.
Optional
min_id?: stringReturn results immediately newer than ID.
Optional
only_media?: booleanShow only statuses with media attached? Defaults to false.
Optional
since_id?: stringReturn results newer than ID.
Array of statuses.
Lookup account ID from Webfinger address.
Webfinger address.
Account
Mute the given account. Clients should filter statuses and notifications from this account, if received,
The account ID.
Mute notifications in addition to statuses.
Relationship
Mute a conversation.
The target status id.
Status
Add the given account to the user’s featured profiles.
The account ID.
Relationship
Pin status to profile.
The target status id.
Status
Publish a status with the given parameters.
Text content of status.
Optional
options: {Optional
in_reply_to_id?: stringID of the status being replied to, if status is a reply.
Optional
language?: stringISO 639 language code for this status.
Optional
media_ids?: string[]Array of Attachment ids.
Optional
poll?: {Poll object.
Optional
quote_id?: stringID of the status being quoted to, if status is a quote.
Optional
scheduled_at?: stringISO 8601 Datetime at which to schedule a status.
Optional
sensitive?: booleanMark status and attached media as sensitive?
Optional
spoiler_text?: stringText to be shown as a warning or subject before the actual content.
Optional
visibility?: StatusVisibilityVisibility of the posted status.
Status. When options.scheduled_at is present, ScheduledStatus is returned instead.
Mark a conversation as read.
Target conversation ID.
Conversation.
Mark as read all unread notifications.
Refresh OAuth access token. Send refresh token and get new access token.
will be generated by #createApp or #registerApp
will be generated by #createApp or #registerApp
will be get #fetchAccessToken
Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.
Username for the account.
Email for the account.
Password for the account.
Whether the user agrees to the local rules, terms, and policies.
The language of the confirmation email that will be sent
Optional
reason: null | stringText that will be reviewed by moderators if registrations require manual approval.
An account token.
First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.
Form Data, which is sent to /api/v1/apps
Form Data, which is sent to /api/v1/apps. and properties should be snake_case
Reject the follow request.
Target account ID. Or follow request ID in Friendica.
Relationship.
Remove a reaction from an announcement.
The ID of the Announcement in the database.
Unicode emoji, or the shortcode of a custom emoji.
File a report.
Target account ID.
Optional
options: {Optional
category?: CategorySpecify if the report is due to spam, violation of enumerated instance rules, or some other reason. Defaults to other. Will be set to violation if rule_ids[] is provided (regardless of any category value you provide).
The reason for the report. Default maximum of 1000 characters.
Optional
forward?: booleanIf the account is remote, should the report be forwarded to the remote admin?
Optional
rule_ids?: number[]For violation category reports, specify the ID of the exact rules broken. Rules and their IDs are available via GET /api/v1/instance/rules and GET /api/v1/instance.
Optional
status_ids?: string[]Array of Statuses ids to attach to the report.
Report
Revoke an OAuth token.
will be generated by #createApp or #registerApp
will be generated by #createApp or #registerApp
will be get #fetchAccessToken
Save your position in a timeline.
Optional
options: { home?: { last_read_id: string }; notifications?: { last_read_id: string } }Optional
home?: { last_read_id: string }Marker position of the last read status ID in home timeline.
Optional
notifications?: { last_read_id: string }Marker position of the last read notification ID in notifications.
Marker.
Update a scheduled status’s publishing date.
Target scheduled status ID.
Optional
scheduled_at: null | stringISO 8601 Datetime at which the status will be published.
ScheduledStatus.
Perform a search.
The search query.
Optional
options: {Optional
account_id?: stringIf provided, statuses returned will be authored only by this account.
Optional
exclude_unreviewed?: booleanFilter out unreviewed tags? Defaults to false.
Optional
following?: booleanOnly include accounts that the user is following. Defaults to false.
Optional
limit?: numberMaximum number of results to load, per type. Defaults to 20. Max 40.
Optional
max_id?: stringReturn results older than this id.
Optional
min_id?: stringReturn results immediately newer than this id.
Optional
offset?: numberOptional
resolve?: booleanAttempt WebFinger lookup. Defaults to false.
Optional
type?: "accounts" | "hashtags" | "statuses"Enum of search target.
Results.
Search for matching accounts by username or display name.
Search query.
Optional
options: {Optional
following?: booleanOptional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_id?: stringReturn results older than ID.
Optional
resolve?: booleanOptional
since_id?: stringReturn results newer than ID.
The array of accounts.
Sets a private note on a user.
The account ID.
Optional
note: stringThe comment to be set on that user.
Relationship
Subscribe to receive notifications for all statuses posted by a user.
Target account ID.
Relationship.
Subscribe to push notifications.
Optional
data: PushSubscription.
Unblock the given account.
The account ID.
RElationship
Remove a domain block, if it exists in the user’s array of blocked domains.
Domain to unblock
Undo bookmark of a status.
The target status id.
Status.
Undo favourite of a status.
The target status id.
Status.
Unfollow the given account.
The account ID.
Relationship
Unfollow a hashtag. Posts containing this hashtag will no longer be inserted into your home timeline.
Target hashtag id.
Tag
Unmute the given account.
The account ID.
Relationship
Unmute a conversation.
The target status id.
Status
Remove the given account from the user’s featured profiles.
The account ID.
Relationship
Unpin status from profile.
The target status id.
Status
Undo boost of a status.
The target status id.
Status.
Unsubscribe to stop receiving notifications from user statuses.
Target account ID.
Relationship.
Update the user’s display and preferences.
Optional
options: {Optional
avatar?: stringAvatar image encoded using multipart/form-data.
Optional
bot?: booleanWhether the account has a bot flag.
Optional
discoverable?: booleanWhether the account should be shown in the profile directory.
Optional
display_name?: stringThe display name to use for the profile.
Optional
fields_attributes?: { name: string; value: string }[]The profile fields to be set. Inside this hash, the key is an integer cast to a string (although the exact integer does not matter), and the value is another hash including name and value. By default, max 4 fields.
Optional
header?: stringHeader image encoded using multipart/form-data.
Optional
locked?: booleanWhether manual approval of follow requests is required.
Optional
note?: stringThe account bio.
Optional
source?: { language?: string; privacy?: string; sensitive?: boolean }Optional
language?: stringDefault language to use for authored statuses (ISO 6391).
Optional
privacy?: stringDefault post privacy for authored statuses. Can be public, unlisted, or private.
Optional
sensitive?: booleanWhether to mark authored statuses as sensitive by default.
An account.
Replaces a filter’s parameters in-place.
The filter ID.
Text to be filtered.
Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
Optional
options: { expires_in?: string; irreversible?: boolean; whole_word?: boolean }Optional
expires_in?: stringISO 8601 Datetime for when the filter expires.
Optional
irreversible?: booleanShould the server irreversibly drop matching entities from home and notifications?
Optional
whole_word?: booleanConsider word boundaries?
Filter
Update a list.
Target list ID.
New list name.
List.
Update media attachment.
Target media ID.
Optional
options: { description?: string; file?: any; focus?: string; is_sensitive?: boolean }Optional
description?: stringA plain-text description of the media.
Optional
file?: anyThe file to be attached, using multipart form data.
Optional
focus?: stringTwo floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Optional
is_sensitive?: booleanWhether the media is sensitive.
Attachment
Change types of notifications.
Optional
data: PushSubscription.
Upload media as an attachment.
The file to be attached, using multipart form data.
Optional
options: { description?: string; focus?: string }Optional
description?: stringA plain-text description of the media.
Optional
focus?: stringTwo floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Attachment
Vote on a poll.
Target poll ID.
Array of own votes containing index for each option (starting from 0).
Optional
status_id: null | stringPoll
Accept the follow request.