access token from OAuth2 authorization
UserAgent is specified in header on request.
POST /api/v1/follow_requests/:id/authorize
Target account ID.
Relationship.
POST /api/v1/lists/:id/accounts
Target list ID.
Array of account IDs to add to the list.
PUT /api/v1/announcements/:id/reactions/:name
POST /api/v1/accounts/:id/block
The account ID.
Relationship
POST /api/v1/statuses/:id/bookmark
The target status id.
Status.
Cancel all requests in this instance.
void
DELETE /api/v1/scheduled_statuses/:id
Target scheduled status ID.
Call /api/v1/apps
Create an application.
your application's name
Form Data
PUT /api/v1/pleroma/statuses/:status_id/reactions/:emoji
Target status ID.
Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
POST /api/v1/featured_tags
Target hashtag name.
FeaturedTag.
POST /api/v1/filters
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
DELETE /api/v1/lists/:id/accounts
Target list ID.
Array of account IDs to add to the list.
DELETE /api/v1/conversations/:id
Target conversation ID.
DELETE /api/v1/pleroma/statuses/:status_id/reactions/:emoji
Target status ID.
Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
DELETE /api/v1/featured_tags/:id
Target featured tag id.
Empty
DELETE /api/v1/filters/:id
The filter ID.
Removed filter.
DELETE /api/v1/push/subscription
DELETE /api/v1/statuses/:id
The target status id.
Status
POST /api/v1/announcements/:id/dismiss
The ID of the Announcement in the database.
POST /api/v1/notifications/:id/dismiss
Target notification ID.
POST /api/v1/notifications/clear
PUT /api/v1/statuses/:id * *
The target status id. *
Status
POST /api/v1/statuses/:id/favourite
The target status id.
Status.
POST /oauth/token
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
must be the same uri as the time when you register your OAuth application
POST /api/v1/accounts/:id/follow
The account ID.
Optional
options: { reblog?: boolean }Relationship
Generate authorization url using OAuth2.
your OAuth app's client ID
your OAuth app's client Secret
as property, redirect_uri and scope are available, and must be the same as when you register your app
GET /api/v1/accounts/:id
The account ID.
An account.
GET /api/v1/pleroma/accounts/:id/favourites
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.
GET /api/v1/accounts/:id/followers
The account ID.
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.
The array of accounts.
GET /api/v1/accounts/:id/following
The account ID.
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.
The array of accounts.
GET /api/v1/accounts/:id/lists
The account ID.
The array of lists.
GET /api/v1/lists/:id/accounts
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.
GET /api/v1/accounts/:id/statuses
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
only_media?: booleanShow only statuses with media attached? Defaults to false.
Optional
pinned?: booleanReturn statuses which include pinned statuses.
Optional
since_id?: stringReturn results newer than ID but starting with most recent.
Account's statuses.
GET /api/v1/blocks
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 /api/v1/bookmarks
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.
GET /api/v1/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.
GET /api/v1/domain_blocks
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 /api/v1/pleroma/statuses/:status_id/reactions/:emoji
Target status ID.
Reaction emoji string. This string is raw unicode emoji or custom emoji name (not shortcode).
GET /api/v1/pleroma/statuses/:status_id/reactions
Target status ID.
GET /api/v1/endorsements
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.
GET /api/v1/favourites
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.
GET /api/v1/follow_requests
Optional
limit: numberMaximum number of results.
Array of account.
GET /api/v1/timelines/home
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.
GET /api/v1/accounts/:id/identity_proofs
The account ID.
Array of IdentityProof
GET /api/v1/instance
GET /api/v1/instance/activity
GET /api/v1/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.
GET /api/v1/instance/peers
GET /api/v1/trends
Optional
limit: null | numberMaximum number of results to return. Defaults to 10.
GET /api/v1/timelines/list/:list_id
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.
GET /api/v1/timelines/public
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 /api/v1/markers
Marker or empty object.
GET /api/v1/media/:id
Target media ID.
Attachment
GET /api/v1/mutes
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 /api/v1/notifications/:id
Target notification ID.
Notification.
GET /api/v1/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 /api/v1/timelines/public
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 /api/v1/accounts/relationships
The account ID.
Relationship
Get multiple relationships in one method
Array of account IDs.
Array of Relationship.
GET /api/v1/scheduled_statuses/:id
Target status ID.
ScheduledStatus.
GET /api/v1/scheduled_statuses
Optional
options: {Optional
limit?: null | numberMax number of results to return. Defaults to 20.
Optional
max_id?: null | stringReturn results older than ID.
Optional
min_id?: null | stringReturn results immediately newer than ID.
Optional
since_id?: null | stringReturn results newer than ID.
Array of scheduled statuses.
GET /api/v1/statuses/:id
The target status id.
Status
GET /api/v1/statuses/:id/context
Get parent and child statuses.
The target status id.
Optional
options: { limit?: number; max_id?: string; since_id?: string }Context
GET /api/v1/statuses/:id/favourited_by
The target status id.
Array of accounts.
GET /api/v1/statuses/:id/reblogged_by
The target status id.
Array of accounts.
GET /api/v1/statuses/:id/source
Obtain the source properties for a status so that it can be edited.
The target status id.
StatusSource
GET /api/v1/suggestions
Optional
limit: numberMaximum number of results.
Array of accounts.
GET /api/v1/timelines/tag/:hashtag
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.
GET /api/v1/accounts/lookup
The username or Webfinger address to lookup.
Account.
POST /api/v1/accounts/:id/mute
The account ID.
Mute notifications in addition to statuses.
Relationship
POST /api/v1/statuses/:id/mute
The target status id.
Status
POST /api/v1/accounts/:id/pin
The account ID.
Relationship
POST /api/v1/statuses/:id/pin
The target status id.
Status
POST /api/v1/statuses
Text content of status.
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?: "direct" | "private" | "public" | "unlisted"Visibility of the posted status.
Status. When options.scheduled_at is present, ScheduledStatus is returned instead.
POST /api/v1/conversations/:id/read
Target conversation ID.
Conversation.
POST /api/v1/pleroma/notifcations/read
Array of notifications
POST /api/v1/statuses/:id/reblog
The target status id.
Status.
POST /oauth/token
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
POST /api/v1/accounts
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
POST /api/v1/follow_requests/:id/reject
Target account ID.
Relationship.
POST /api/v1/reports
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
POST /oauth/revoke
Revoke an OAuth token.
will be generated by #createApp or #registerApp
will be generated by #createApp or #registerApp
will be get #fetchAccessToken
POST /api/v1/markers
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.
PUT /api/v1/scheduled_statuses/:id
Target scheduled status ID.
Optional
scheduled_at: null | stringISO 8601 Datetime at which the status will be published.
ScheduledStatus.
GET /api/v2/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.
GET /api/v1/accounts/search
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.
Relationship
POST /api/v1/accounts/:id/follow
Target account ID.
Relationship.
POST /api/v1/push/subscription
Optional
data: PushSubscription.
POST /api/v1/accounts/:id/unblock
The account ID.
RElationship
DELETE /api/v1/domain_blocks
Domain to unblock
POST /api/v1/statuses/:id/unbookmark
The target status id.
Status.
POST /api/v1/statuses/:id/unfavourite
The target status id.
Status.
POST /api/v1/accounts/:id/unfollow
The account ID.
Relationship
POST /api/v1/accounts/:id/unmute
The account ID.
Relationship
POST /api/v1/statuses/:id/unmute
The target status id.
Status
POST /api/v1/accounts/:id/unpin
The account ID.
Relationship
POST /api/v1/statuses/:id/unpin
The target status id.
Status
POST /api/v1/statuses/:id/unreblog
The target status id.
Status.
POST /api/v1/accounts/:id/follow
Target account ID.
Relationship.
PATCH /api/v1/accounts/update_credentials
Optional
options: {An account.
PUT /api/v1/filters/:id
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
PUT /api/v1/lists/:id
Target list ID.
New list name.
List.
PUT /api/v1/media/:id
Target media ID.
Optional
options: { description?: string; file?: any; focus?: string }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.
Attachment
PUT /api/v1/push/subscription
Optional
data: PushSubscription.
POST /api/v2/media
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
POST /api/v1/polls/:id/votes
Target poll ID.
Array of own votes containing index for each option (starting from 0).
Poll
hostname or base URL