access token from OAuth2 authorization
UserAgent is specified in header on request.
Proxy setting, or set false if don't use proxy.
POST /api/v1/follow_requests/:id/authorize
Relationship.
POST /api/v1/lists/:id/accounts
POST /api/v1/accounts/:id/block
Relationship
POST/api/v1/domain_blocks
Cancel all requests in this instance.
void
DELETE /api/v1/scheduled_statuses/:id
Call /api/v1/apps
Create an application.
your application's name
Form Data
POST /api/v1/featured_tags
FeaturedTag.
DELETE /api/v1/lists/:id/accounts
DELETE /api/v1/conversations/:id
DELETE /api/v1/featured_tags/:id
Empty
DELETE /api/v1/lists/:id
DELETE /api/v1/push/subscription
POST /api/v1/notifications/:id/dismiss
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.
POST /api/v1/accounts/:id/follow
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/statuses
Account's statuses.
GET /api/v1/conversations
Array of statuses.
GET /api/v1/domain_blocks
Array of domain name.
GET /api/v1/featured_tags
Array of featured tag.
GET /api/v1/timelines/home
Array of statuses.
GET /api/v1/accounts/:id/identity_proofs
Array of IdentityProof
GET /api/v1/instance/peers
GET /api/v1/timelines/list/:list_id
Array of statuses.
GET /api/v1/timelines/public
Array of statuses.
GET /api/v1/notifications/:id
Notification.
GET /api/v1/notifications
Array of notifications.
GET /api/v1/preferences
Preferences.
GET /api/v1/timelines/public
Array of statuses.
GET /api/v1/push/subscription
PushSubscription.
GET /api/v1/accounts/relationships
Relationship
Get multiple relationships in one method
Array of Relationship.
GET /api/v1/scheduled_statuses/:id
ScheduledStatus.
GET /api/v1/scheduled_statuses
Array of scheduled statuses.
GET /api/v1/timelines/tag/:hashtag
Array of statuses.
POST /api/v1/accounts/:id/mute
Relationship
POST /api/v1/accounts/:id/pin
Relationship
POST /api/v1/statuses
Status
POST /api/v1/conversations/:id/read
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.
First, call createApp to get client_id and client_secret. Next, call generateAuthUrl to get authorization url.
POST /api/v1/follow_requests/:id/reject
Relationship.
POST /oauth/revoke
Revoke an OAuth token.
PUT /api/v1/scheduled_statuses/:id
ScheduledStatus.
GET /api/v2/search
Results.
GET /api/v1/accounts/search
The array of accounts.
POST /api/v1/pleroma/accounts/:id/subscribe
Relationship.
POST /api/v1/push/subscription
PushSubscription.
POST /api/v1/accounts/:id/unblock
RElationship
DELETE /api/v1/domain_blocks
POST /api/v1/accounts/:id/unfollow
Relationship
POST /api/v1/accounts/:id/unmute
Relationship
POST /api/v1/accounts/:id/unpin
Relationship
POST /api/v1/pleroma/accounts/:id/unsubscribe
Relationship.
PATCH /api/v1/accounts/update_credentials
An account.
PUT /api/v1/media/:id
Attachment
PUT /api/v1/push/subscription
PushSubscription.
POST /api/v1/media
Attachment
GET /api/v1/apps/verify_credentials
An Application
Generated using TypeDoc
hostname or base URL