Target account ID.
POST /api/v1/accounts/:id/block
Relationship
The account ID.
Call /api/v1/apps
Create an application.
your application's name
Form Data
POST /api/v1/featured_tags
FeaturedTag.
Target hashtag name.
POST /api/v1/filters
Filter
Text to be filtered.
Array of enumerable strings home, notifications, public, thread, account. At least one context must be specified.
Optional
options: { Optional
expires_ISO 8601 Datetime for when the filter expires.
Optional
irreversible?: booleanShould the server irreversibly drop matching entities from home and notifications?
Optional
whole_Consider word boundaries?
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
Optional
redirect_uri: stringmust be the same uri as the time when you register your OAuth application
POST /api/v1/accounts/:id/follow
Relationship
The account ID.
Optional
options: { Optional
reblog?: booleanGET /api/v1/pleroma/accounts/:id/favourites
Array of statuses.
Target account ID.
Optional
options: { Optional
limit?: numberMax number of results to return.
Optional
max_Return results order than ID.
Optional
since_Return results newer than ID.
GET /api/v1/accounts/:id/followers
The array of accounts.
The account ID.
Optional
options: { Optional
get_Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
since_Return results newer than ID.
Optional
sleep_GET /api/v1/accounts/:id/following
The array of accounts.
The account ID.
Optional
options: { Optional
get_Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
since_Return results newer than ID.
Optional
sleep_GET /api/v1/accounts/:id/statuses
Account's statuses.
The account ID.
Optional
options: { Optional
exclude_Return statuses which exclude reblogs.
Optional
exclude_Return statuses which exclude replies.
Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results newer than ID.
Optional
only_Show only statuses with media attached? Defaults to false.
Optional
pinned?: booleanReturn statuses which include pinned statuses.
Optional
since_Return results newer than ID but starting with most recent.
GET /api/v1/lists/:id/accounts
Array of accounts.
Target list ID.
Optional
options: { Optional
limit?: numberMax number of results to return.
Optional
max_Return results older than ID.
Optional
since_Return results newer than ID.
GET /api/v1/blocks
Array of accounts.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
GET /api/v1/bookmarks
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/conversations
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/domain_blocks
Array of domain name.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
GET /api/v1/endorsements
Array of accounts.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
since_Return results newer than ID.
GET /api/v1/favourites
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
GET /api/v1/featured_tags
Array of featured tag.
GET /api/v1/timelines/home
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
local?: booleanShow only local statuses? Defaults to false.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/accounts/:id/identity_proofs
Array of IdentityProof
The account ID.
GET /api/v1/directory
Array of accounts.
Optional
options: { 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.
GET /api/v1/timelines/list/:list_id
Array of statuses.
Local ID of the list in the database.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/timelines/public
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
only_Show only statuses with media attached? Defaults to false.
Optional
since_Return results newer than ID.
GET /api/v1/media/:id
Attachment
Target media ID.
GET /api/v1/mutes
Array of accounts.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
GET /api/v1/notifications/:id
Notification.
Target notification ID.
GET /api/v1/notifications
Array of notifications.
Optional
options: { Optional
account_Return only notifications received from this account.
Optional
exclude_Array of types to exclude.
Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/preferences
Preferences.
GET /api/v1/timelines/public
Array of statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
only_Show only statuses with media attached? Defaults to false.
Optional
since_Return results newer than ID.
GET /api/v1/push/subscription
PushSubscription.
GET /api/v1/accounts/relationships
Relationship
The account ID.
Get multiple relationships in one method
Array of Relationship.
Array of account IDs.
GET /api/v1/scheduled_statuses/:id
ScheduledStatus.
Target status ID.
GET /api/v1/scheduled_statuses
Array of scheduled statuses.
Optional
options: { Optional
limit?: numberMax number of results to return. Defaults to 20.
Optional
max_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
since_Return results newer than ID.
GET /api/v1/statuses/:id/context
Get parent and child statuses.
Context
The target status id.
Optional
options: { Optional
limit?: numberOptional
max_Optional
since_GET /api/v1/timelines/tag/:hashtag
Array of statuses.
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_Return results older than ID.
Optional
min_Return results immediately newer than ID.
Optional
only_Show only statuses with media attached? Defaults to false.
Optional
since_Return results newer than ID.
POST /api/v1/accounts/:id/mute
Relationship
The account ID.
Mute notifications in addition to statuses.
POST /api/v1/accounts/:id/pin
Relationship
The account ID.
POST /api/v1/statuses
Status
Text content of status.
Optional
options: { Optional
in_ID of the status being replied to, if status is a reply.
Optional
language?: stringISO 639 language code for this status.
Optional
media_Array of Attachment ids.
Optional
poll?: { Poll object.
Optional
hide_Optional
multiple?: booleanOptional
quote_ID of the status being quoted to, if status is a quote.
Optional
scheduled_ISO 8601 Datetime at which to schedule a status.
Optional
sensitive?: booleanMark status and attached media as sensitive?
Optional
spoiler_Text to be shown as a warning or subject before the actual content.
Optional
visibility?: "direct" | "private" | "public" | "unlisted"Visibility of the posted status.
POST /api/v1/conversations/:id/read
Conversation.
Target conversation ID.
POST /api/v1/pleroma/notifcations/read
Array of notifications
Optional
id?: stringOptional
max_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
An account token.
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.
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
Relationship.
Target account ID.
POST /api/v1/reports
Report
Target account ID.
Reason of the report.
Optional
options: { Optional
forward?: booleanIf the account is remote, should the report be forwarded to the remote admin?
Optional
status_Array of Statuses ids to attach to the 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
Marker.
Optional
options: { Optional
home?: { Marker position of the last read status ID in home timeline.
Optional
notifications?: { Marker position of the last read notification ID in notifications.
PUT /api/v1/scheduled_statuses/:id
ScheduledStatus.
Target scheduled status ID.
Optional
scheduled_at: null | stringISO 8601 Datetime at which the status will be published.
GET /api/v2/search
Results.
The search query.
Enum of search target.
Optional
options: { Optional
account_If provided, statuses returned will be authored only by this account.
Optional
exclude_Filter 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_Return results older than this id.
Optional
min_Return results immediately newer than this id.
Optional
offset?: numberOptional
resolve?: booleanAttempt WebFinger lookup. Defaults to false.
GET /api/v1/accounts/search
The array of accounts.
Search query.
Optional
options: { Optional
following?: booleanOptional
limit?: numberMax number of results to return. Defaults to 40.
Optional
max_Return results older than ID.
Optional
resolve?: booleanOptional
since_Return results newer than ID.
POST /api/v1/pleroma/accounts/:id/subscribe
Relationship.
Target account ID.
POST /api/v1/push/subscription
PushSubscription.
Optional
data: null | { POST /api/v1/accounts/:id/unblock
RElationship
The account ID.
POST /api/v1/accounts/:id/unfollow
Relationship
The account ID.
POST /api/v1/accounts/:id/unmute
Relationship
The account ID.
POST /api/v1/accounts/:id/unpin
Relationship
The account ID.
POST /api/v1/pleroma/accounts/:id/unsubscribe
Relationship.
Target account ID.
PATCH /api/v1/accounts/update_credentials
An account.
Optional
options: { Optional
avatar?: stringOptional
bot?: booleanOptional
discoverable?: booleanOptional
display_Optional
fields_Optional
header?: stringOptional
locked?: booleanOptional
note?: stringOptional
source?: { Optional
language?: stringOptional
privacy?: stringOptional
sensitive?: booleanPUT /api/v1/filters/:id
Filter
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: { Optional
expires_ISO 8601 Datetime for when the filter expires.
Optional
irreversible?: booleanShould the server irreversibly drop matching entities from home and notifications?
Optional
whole_Consider word boundaries?
PUT /api/v1/media/:id
Attachment
Target media ID.
Optional
options: { 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_Whether the media is sensitive.
PUT /api/v1/push/subscription
PushSubscription.
Optional
data: null | { POST /api/v2/media
Attachment
The file to be attached, using multipart form data.
Optional
options: { 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.
GET /api/v1/apps/verify_credentials
An Application
POST /api/v1/polls/:id/votes
Poll
Target poll ID.
Array of own votes containing index for each option (starting from 0).
Optional
status_id: null | stringGenerated using TypeDoc
POST /api/v1/follow_requests/:id/authorize
Returns
Relationship.