Target account ID.
Relationship.
POST /api/v1/lists/:id/accounts
Target list ID.
Array of account IDs to add to the list.
POST /api/v1/accounts/:id/block
The account ID.
Relationship
POST/api/v1/domain_blocks
Domain to block.
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
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.
ISO 8601 Datetime for when the filter expires.
Should the server irreversibly drop matching entities from home and notifications?
Consider 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/featured_tags/:id
Target featured tag id.
Empty
DELETE /api/v1/lists/:id
Target list ID.
DELETE /api/v1/push/subscription
DELETE /api/v1/statuses/:id
The target status id.
Status
POST /api/v1/notifications/:id/dismiss
Target notification ID.
POST /api/v1/notifications/clear
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.
Relationship
GET /api/v1/pleroma/accounts/:id/favourites
Target account ID.
Max number of results to return.
Return results order than ID.
Return results newer than ID.
Array of statuses.
GET /api/v1/accounts/:id/followers
The account ID.
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results newer than ID.
The array of accounts.
GET /api/v1/accounts/:id/following
The account ID.
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results newer than ID.
The array of accounts.
GET /api/v1/accounts/:id/statuses
The account ID.
Return statuses which exclude reblogs.
Return statuses which exclude replies.
Max number of results to return. Defaults to 20.
Return results older than ID.
Show only statuses with media attached? Defaults to false.
Return statuses which include pinned statuses.
Return results newer than ID.
Account's statuses.
GET /api/v1/lists/:id/accounts
Target list ID.
Max number of results to return.
Return results older than ID.
Return results newer than ID.
Array of accounts.
GET /api/v1/blocks
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results immediately newer than ID.
Array of accounts.
GET /api/v1/bookmarks
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of statuses.
GET /api/v1/conversations
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of statuses.
GET /api/v1/domain_blocks
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results immediately newer than ID.
Array of domain name.
GET /api/v1/endorsements
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results newer than ID.
Array of accounts.
GET /api/v1/favourites
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results immediately newer than ID.
Array of statuses.
GET /api/v1/featured_tags
Array of featured tag.
GET /api/v1/timelines/home
Max number of results to return. Defaults to 20.
Show only local statuses? Defaults to false.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of statuses.
GET /api/v1/accounts/:id/identity_proofs
The account ID.
Array of IdentityProof
GET /api/v1/directory
How many accounts to load. Default 40.
Only return local accounts.
How many accounts to skip before returning results. Default 0.
Order of results.
Array of accounts.
GET /api/v1/instance/peers
GET /api/v1/timelines/list/:list_id
Local ID of the list in the database.
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of statuses.
GET /api/v1/timelines/public
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Show only statuses with media attached? Defaults to false.
Return results newer than ID.
Array of statuses.
GET /api/v1/mutes
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results immediately newer than ID.
Array of accounts.
GET /api/v1/notifications/:id
Target notification ID.
Notification.
GET /api/v1/notifications
Return only notifications received from this account.
Array of types to exclude.
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of notifications.
GET /api/v1/preferences
Preferences.
GET /api/v1/timelines/public
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Show only statuses with media attached? Defaults to false.
Return results newer than ID.
Array of statuses.
GET /api/v1/push/subscription
PushSubscription.
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
Max number of results to return. Defaults to 20.
Return results older than ID.
Return results immediately newer than ID.
Return results newer than ID.
Array of scheduled statuses.
GET /api/v1/timelines/tag/:hashtag
Content of a #hashtag, not including # symbol.
Max number of results to return. Defaults to 20.
Show only local statuses? Defaults to false.
Return results older than ID.
Return results immediately newer than ID.
Show only statuses with media attached? Defaults to false.
Return results newer than ID.
Array of statuses.
POST /api/v1/accounts/:id/mute
The account ID.
Mute notifications in addition to statuses.
Relationship
POST /api/v1/accounts/:id/pin
The account ID.
Relationship
POST /api/v1/statuses
Text content of status.
ID of the status being replied to, if status is a reply.
ISO 639 language code for this status.
Array of Attachment ids.
Poll object.
ID of the status being quoted to, if status is a quote.
ISO 8601 Datetime at which to schedule a status.
Mark status and attached media as sensitive?
Text to be shown as a warning or subject before the actual content.
Visibility of the posted status.
Status
POST /api/v1/conversations/:id/read
Target conversation ID.
Conversation.
POST /api/v1/pleroma/notifcations/read
Array of notifications
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
Text 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.
Reason of the report.
If the account is remote, should the report be forwarded to the remote admin?
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
Marker position of the last read status ID in home timeline.
Marker position of the last read notification ID in notifications.
Marker.
PUT /api/v1/scheduled_statuses/:id
Target scheduled status ID.
ISO 8601 Datetime at which the status will be published.
ScheduledStatus.
GET /api/v2/search
The search query.
Enum of search target.
If provided, statuses returned will be authored only by this account.
Filter out unreviewed tags? Defaults to false.
Only include accounts that the user is following. Defaults to false.
Maximum number of results to load, per type. Defaults to 20. Max 40.
Return results older than this id.
Return results immediately newer than this id.
Attempt WebFinger lookup. Defaults to false.
Results.
GET /api/v1/accounts/search
Search query.
Max number of results to return. Defaults to 40.
Return results older than ID.
Return results newer than ID.
The array of accounts.
POST /api/v1/pleroma/accounts/:id/subscribe
Target account ID.
Relationship.
POST /api/v1/push/subscription
PushSubscription.
POST /api/v1/accounts/:id/unblock
The account ID.
RElationship
DELETE /api/v1/domain_blocks
Domain to unblock
POST /api/v1/accounts/:id/unfollow
The account ID.
Relationship
POST /api/v1/accounts/:id/unmute
The account ID.
Relationship
POST /api/v1/accounts/:id/unpin
The account ID.
Relationship
POST /api/v1/pleroma/accounts/:id/unsubscribe
Target account ID.
Relationship.
PATCH /api/v1/accounts/update_credentials
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.
ISO 8601 Datetime for when the filter expires.
Should the server irreversibly drop matching entities from home and notifications?
Consider word boundaries?
Filter
PUT /api/v1/media/:id
Target media ID.
A plain-text description of the media.
The file to be attached, using multipart form data.
Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Whether the media is sensitive.
Attachment
PUT /api/v1/push/subscription
PushSubscription.
POST /api/v1/media
The file to be attached, using multipart form data.
A plain-text description of the media.
Two floating points (x,y), comma-delimited, ranging from -1.0 to 1.0.
Attachment
GET /api/v1/apps/verify_credentials
An Application
Generated using TypeDoc
POST /api/v1/follow_requests/:id/authorize