access token from OAuth2 authorization
UserAgent is specified in header on request.
Proxy setting, or set false if don't use proxy.
POST /api/following/requests/accept
POST /api/blocking/create
POST /api/app/create
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_Optional
irreversible?: booleanOptional
whole_POST /api/auth/session/userkey
This parameter is not used in this method.
Application secret key which will be provided in createApp.
Session token string which will be provided in generateAuthUrlAndToken.
Optional
_redirect_uri: stringThis parameter is not used in this method.
POST /api/following/create
Optional
_options: { Optional
reblog?: booleanGET /api/v1/pleroma/accounts/:id/favourites
Array of statuses.
Target account ID.
Optional
_options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/users/followers
Optional
options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/users/following
Optional
options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/users/notes
Optional
options: { Optional
limit?: numberOptional
max_Optional
only_Optional
pinned?: booleanOptional
since_POST /api/users/lists/show
Optional
_options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/blocking/list
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_GET /api/v1/bookmarks
Array of statuses.
Optional
_options: { Optional
limit?: numberOptional
max_Optional
min_Optional
since_POST /api/notes/mentions
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_Optional
since_GET /api/v1/domain_blocks
Array of domain name.
Optional
_options: { Optional
limit?: numberOptional
max_Optional
min_GET /api/v1/endorsements
Array of accounts.
Optional
_options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/i/favorites
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_GET /api/v1/featured_tags
Array of featured tag.
POST /api/notes/timeline
Optional
options: { Optional
limit?: numberOptional
local?: booleanOptional
max_Optional
min_Optional
since_GET /api/v1/accounts/:id/identity_proofs
Array of IdentityProof
The account ID.
GET /api/v1/directory
Array of accounts.
Optional
_options: { Optional
limit?: numberOptional
local?: booleanOptional
offset?: numberOptional
order?: "active" | "new"POST /api/notes/user-list-timeline
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_Optional
since_POST /api/notes/local-timeline
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_Optional
only_Optional
since_GET /api/v1/media/:id
Attachment
Target media ID.
POST /api/mute/list
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_GET /api/v1/notifications/:id
Notification.
Target notification ID.
POST /api/i/notifications
Optional
options: { Optional
account_Optional
exclude_Optional
limit?: numberOptional
max_Optional
min_Optional
since_GET /api/v1/preferences
Preferences.
POST /api/notes/global-timeline
Optional
options: { Optional
limit?: numberOptional
max_Optional
min_Optional
only_Optional
since_GET /api/v1/push/subscription
PushSubscription.
POST /api/users/relation
The accountID, for example '1sdfag'
POST /api/users/relation
GET /api/v1/scheduled_statuses/:id
ScheduledStatus.
Target status ID.
GET /api/v1/scheduled_statuses
Array of scheduled statuses.
Optional
_options: { Optional
limit?: numberOptional
max_Optional
min_Optional
since_POST /api/notes/children
Optional
options: { Optional
limit?: numberOptional
max_Optional
since_POST /api/notes/search-by-tag
Optional
options: { Optional
limit?: numberOptional
local?: booleanOptional
max_Optional
min_Optional
only_Optional
since_POST /api/mute/create
POST /api/v1/accounts/:id/pin
Relationship
The account ID.
POST /api/v1/statuses
Status
Text content of status.
Optional
options: { Optional
in_Optional
language?: stringOptional
media_Optional
poll?: { Optional
hide_Optional
multiple?: booleanOptional
quote_Optional
scheduled_Optional
sensitive?: booleanOptional
spoiler_Optional
visibility?: "direct" | "private" | "public" | "unlisted"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/following/requests/reject
POST /api/users/report-abuse
Optional
_options: { Optional
forward?: booleanOptional
status_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?: { Optional
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_Optional
exclude_Optional
following?: booleanOptional
limit?: numberOptional
max_Optional
min_Optional
offset?: numberOptional
resolve?: booleanPOST /api/users/search
Optional
options: { Optional
following?: booleanOptional
limit?: numberOptional
max_Optional
resolve?: booleanOptional
since_POST /api/v1/pleroma/accounts/:id/subscribe
Relationship.
Target account ID.
POST /api/v1/push/subscription
PushSubscription.
Optional
_data: null | { POST /api/blocking/delete
POST /api/following/delete
POST /api/mute/delete
POST /api/v1/accounts/:id/unpin
Relationship
The account ID.
POST /api/v1/pleroma/accounts/:id/unsubscribe
Relationship.
Target account ID.
POST /api/i/update
Optional
options: { Optional
avatar?: stringOptional
bot?: booleanOptional
discoverable?: booleanOptional
display_Optional
fields_Optional
header?: stringOptional
locked?: booleanOptional
note?: stringOptional
source?: null | { PUT /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_Optional
irreversible?: booleanOptional
whole_POST /api/drive/files/update
Optional
options: { Optional
description?: stringOptional
file?: anyOptional
focus?: stringOptional
is_PUT /api/v1/push/subscription
PushSubscription.
Optional
_data: null | { POST /api/drive/files/create
Optional
_options: { Optional
description?: stringOptional
focus?: stringGET /api/v1/apps/verify_credentials
An Application
Generated using TypeDoc
hostname or base URL