- description:Version of the API to use. Must be either `v1` or `v2`.
in:path
name:api_version
required:true
type:string
- description:Image or media description to use as alt-text on the attachment. This is very useful for users of screenreaders! May or may not be required, depending on your instance settings.
in:formData
name:description
type:string
- default:0,0
description: 'Focus of the media file. If present, it should be in the form of two comma-separated floats between -1 and 1. For example:`-0.5,0.25`.'
in:formData
name:focus
type:string
- description:The media attachment to upload.
in:formData
name:file
required:true
type:file
produces:
- application/json
responses:
"200":
description:The newly-created media attachment.
schema:
$ref:'#/definitions/attachment'
"400":
description:bad request
"401":
description:unauthorized
"422":
description:unprocessable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:media
summary:Upload a new media attachment.
tags:
- media
/api/v1/accounts:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description:|-
The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'.
The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'.
operationId:accountCreate
parameters:
- description:Text that will be reviewed by moderators if registrations require manual approval.
in:query
name:reason
type:string
x-go-name:Reason
- description:The desired username for the account.
in:query
name:username
type:string
x-go-name:Username
- description:The email address to be used for login.
in:query
name:email
type:string
x-go-name:Email
- description:The password to be used for login. This will be hashed before storage.
in:query
name:password
type:string
x-go-name:Password
- description:The user agrees to the terms, conditions, and policies of the instance.
in:query
name:agreement
type:boolean
x-go-name:Agreement
- description:The language of the confirmation email that will be sent.
in:query
name:locale
type:string
x-go-name:Locale
produces:
- application/json
responses:
"200":
description:An OAuth2 access token for the newly-created account.
schema:
$ref:'#/definitions/oauthToken'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Application:
- write:accounts
summary:Create a new account using an application token.
tags:
- accounts
/api/v1/accounts/{id}:
get:
operationId:accountGet
parameters:
- description:The id of the requested account.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The requested account.
schema:
$ref:'#/definitions/account'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:Get information about an account with the given ID.
tags:
- accounts
/api/v1/accounts/{id}/block:
post:
operationId:accountBlock
parameters:
- description:The id of the account to block.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Your relationship to the account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:blocks
summary:Block account with id.
tags:
- accounts
/api/v1/accounts/{id}/follow:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description:|-
The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'.
The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'.
operationId:accountFollow
parameters:
- description:ID of the account to follow.
in:path
name:id
required:true
type:string
- default:true
description:Show reblogs from this account.
in:formData
name:reblogs
type:boolean
- default:false
description:Notify when this account posts.
in:formData
name:notify
type:boolean
produces:
- application/json
responses:
"200":
description:Your relationship to this account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:follows
summary:Follow account with id.
tags:
- accounts
/api/v1/accounts/{id}/followers:
get:
operationId:accountFollowers
parameters:
- description:Account ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Array of accounts that follow this account.
schema:
items:
$ref:'#/definitions/account'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:See followers of account with given id.
tags:
- accounts
/api/v1/accounts/{id}/following:
get:
operationId:accountFollowing
parameters:
- description:Account ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Array of accounts that are followed by this account.
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:See accounts followed by given account id.
tags:
- accounts
/api/v1/accounts/{id}/statuses:
get:
description:The statuses will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
operationId:accountStatuses
parameters:
- description:Account ID.
in:path
name:id
required:true
type:string
- default:30
description:Number of statuses to return.
in:query
name:limit
type:integer
- default:false
description:Exclude statuses that are a reply to another status.
in:query
name:exclude_replies
type:boolean
- default:false
description:Exclude statuses that are a reblog/boost of another status.
in:query
name:exclude_reblogs
type:boolean
- description:Return only statuses *OLDER* than the given max status ID. The status with the specified ID will not be included in the response.
in:query
name:max_id
type:string
- description:Return only statuses *NEWER* than the given min status ID. The status with the specified ID will not be included in the response.
in:query
name:min_id
type:string
- default:false
description:Show only pinned statuses. In other words, exclude statuses that are not pinned to the given account ID.
in:query
name:pinned_only
type:boolean
- default:false
description:Show only statuses with media attachments.
in:query
name:only_media
type:boolean
- default:false
description:Show only statuses with a privacy setting of 'public'.
in:query
name:only_public
type:boolean
produces:
- application/json
responses:
"200":
description:Array of statuses.
schema:
items:
$ref:'#/definitions/status'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:See statuses posted by the requested account.
tags:
- accounts
/api/v1/accounts/{id}/unblock:
post:
operationId:accountUnblock
parameters:
- description:The id of the account to unblock.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Your relationship to this account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:blocks
summary:Unblock account with ID.
tags:
- accounts
/api/v1/accounts/{id}/unfollow:
post:
operationId:accountUnfollow
parameters:
- description:The id of the account to unfollow.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Your relationship to this account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:follows
summary:Unfollow account with id.
tags:
- accounts
/api/v1/accounts/delete:
post:
consumes:
- multipart/form-data
operationId:accountDelete
parameters:
- description:Password of the account user, for confirmation.
in:formData
name:password
required:true
type:string
responses:
"202":
description:The account deletion has been accepted and the account will be deleted.
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:accounts
summary:Delete your account.
tags:
- accounts
/api/v1/accounts/relationships:
get:
operationId:accountRelationships
parameters:
- description:Account IDs.
in:query
items:
type:string
name:id
required:true
type:array
produces:
- application/json
responses:
"200":
description:Array of account relationships.
schema:
items:
$ref:'#/definitions/accountRelationship'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:See your account's relationships with the given account IDs.
tags:
- accounts
/api/v1/accounts/update_credentials:
patch:
consumes:
- multipart/form-data
operationId:accountUpdate
parameters:
- description:Account should be made discoverable and shown in the profile directory (if enabled).
in:formData
name:discoverable
type:boolean
- description:Account is flagged as a bot.
in:formData
name:bot
type:boolean
- allowEmptyValue:true
description:The display name to use for the account.
in:formData
name:display_name
type:string
- allowEmptyValue:true
description:Bio/description of this account.
in:formData
name:note
type:string
- description:Avatar of the user.
in:formData
name:avatar
type:file
- description:Header of the user.
in:formData
name:header
type:file
- description:Require manual approval of follow requests.
in:formData
name:locked
type:boolean
- description:Default post privacy for authored statuses.
in:formData
name:source[privacy]
type:string
- description:Mark authored statuses as sensitive by default.
in:formData
name:source[sensitive]
type:boolean
- description:Default language to use for authored statuses (ISO 6391).
in:formData
name:source[language]
type:string
- description:Default format to use for authored statuses (plain or markdown).
in:formData
name:source[status_format]
type:string
- description:Custom CSS to use when rendering this account's profile or statuses. String must be no more than 5,000 characters (~5kb).
Comma-separated list of filters to apply to results. Recognized filters are:
`domain:[domain]` -- show emojis from the given domain, eg `?filter=domain:example.org` will show emojis from `example.org` only.
Instead of giving a specific domain, you can also give either one of the key words `local` or `all` to show either local emojis only (`domain:local`) or show all emojis from all domains (`domain:all`).
Note:`domain:*` is equivalent to `domain:all` (including local).
If no domain filter is provided, `domain:all` will be assumed.
`disabled` -- include emojis that have been disabled.
`enabled` -- include emojis that are enabled.
`shortcode:[shortcode]` -- show only emojis with the given shortcode, eg `?filter=shortcode:blob_cat_uwu` will show only emojis with the shortcode `blob_cat_uwu` (case sensitive).
If neither `disabled` or `enabled` are provided, both disabled and enabled emojis will be shown.
If no filter query string is provided, the default `domain:all` will be used, which will show all emojis from all domains.
Return only emojis with `[shortcode]@[domain]` *LOWER* (alphabetically) than given `[shortcode]@[domain]`. For example, if `max_shortcode_domain=beep@example.org`, then returned values might include emojis with `[shortcode]@[domain]`s like `car@example.org`, `debian@aaa.com`, `test@` (local emoji), etc.
Emoji with the given `[shortcode]@[domain]` will not be included in the result set.
in:query
name:max_shortcode_domain
type:string
- description:|-
Return only emojis with `[shortcode]@[domain]` *HIGHER* (alphabetically) than given `[shortcode]@[domain]`. For example, if `max_shortcode_domain=beep@example.org`, then returned values might include emojis with `[shortcode]@[domain]`s like `arse@test.com`, `0101_binary@hackers.net`, `bee@` (local emoji), etc.
Emoji with the given `[shortcode]@[domain]` will not be included in the result set.
in:query
name:min_shortcode_domain
type:string
produces:
- application/json
responses:
"200":
description:An array of emojis, arranged alphabetically by shortcode and domain.
headers:
Link:
description:Links to the next and previous queries.
type:string
schema:
items:
$ref:'#/definitions/adminEmoji'
type:array
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
summary:View local and remote emojis available to / known by this instance.
- description:The code to use for the emoji, which will be used by instance denizens to select it. This must be unique on the instance.
in:formData
name:shortcode
pattern:\w{2,30}
required:true
type:string
- description:A png or gif image of the emoji. Animated pngs work too! To ensure compatibility with other fedi implementations, emoji size limit is 50kb by default.
- description:Category in which to place the new emoji. 64 characters or less. If left blank, emoji will be uncategorized. If a category with the given name doesn't exist yet, it will be created.
Action performed depends upon the action `type` provided.
`disable`:disable a REMOTE emoji from being used/displayed on this instance. Does not work for local emojis.
`copy`:copy a REMOTE emoji to this instance. When doing this action, a shortcode MUST be provided, and it must
be unique among emojis already present on this instance. A category MAY be provided, and the copied emoji will then
be put into the provided category.
`modify`:modify a LOCAL emoji. You can provide a new image for the emoji and/or update the category.
Local emojis cannot be deleted using this endpoint. To delete a local emoji, check DELETE /api/v1/admin/custom_emojis/{id} instead.
operationId:emojiUpdate
parameters:
- description:The id of the emoji.
in:path
name:id
required:true
type:string
- description:|-
Type of action to be taken. One of:(`disable`, `copy`, `modify`).
For REMOTE emojis, `copy` or `disable` are supported.
For LOCAL emojis, only `modify` is supported.
in:formData
name:type
required:true
type:string
- description:The code to use for the emoji, which will be used by instance denizens to select it. This must be unique on the instance. Works for the `copy` action type only.
in:formData
name:shortcode
pattern:\w{2,30}
type:string
- description:A new png or gif image to use for the emoji. Animated pngs work too! To ensure compatibility with other fedi implementations, emoji size limit is 50kb by default. Works for LOCAL emojis only.
in:formData
name:image
type:file
- description:Category in which to place the emoji. 64 characters or less. If a category with the given name doesn't exist yet, it will be created.
in:formData
name:category
type:string
produces:
- application/json
responses:
"200":
description:The updated emoji.
schema:
$ref:'#/definitions/adminEmoji'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:Perform admin action on a local or remote emoji known to this instance.
- description:If set to `true`, then each entry in the returned list of domain blocks will only consist of the fields `domain` and `public_comment`. This is perfect for when you want to save and share a list of all the domains you have blocked on your instance, so that someone else can easily import them, but you don't want them to see the database IDs of your blocks, or private comments etc.
in:query
name:export
type:boolean
produces:
- application/json
responses:
"200":
description:All domain blocks currently in place.
schema:
items:
$ref:'#/definitions/domainBlock'
type:array
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:View all domain blocks currently in place.
tags:
- admin
post:
consumes:
- multipart/form-data
description:|-
You have two options when using this endpoint:either you can set `import` to `true` and
upload a file containing multiple domain blocks, JSON-formatted, or you can leave import as
The format of the json file should be something like:`[{"domain":"example.org"},{"domain":"whatever.com","public_comment":"they smell"}]`
operationId:domainBlockCreate
parameters:
- default:false
description:Signal that a list of domain blocks is being imported as a file. If set to `true`, then 'domains' must be present as a JSON-formatted file. If set to `false`, then `domains` will be ignored, and `domain` must be present.
in:query
name:import
type:boolean
- description:JSON-formatted list of domain blocks to import. This is only used if `import` is set to `true`.
in:formData
name:domains
type:file
- description:Single domain to block. Used only if `import` is not `true`.
in:formData
name:domain
type:string
- description:Obfuscate the name of the domain when serving it publicly. Eg., `example.org` becomes something like `ex***e.org`. Used only if `import` is not `true`.
in:formData
name:obfuscate
type:boolean
- description:Public comment about this domain block. This will be displayed alongside the domain block if you choose to share blocks. Used only if `import` is not `true`.
in:formData
name:public_comment
type:string
- description:Private comment about this domain block. Will only be shown to other admins, so this is a useful way of internally keeping track of why a certain domain ended up blocked. Used only if `import` is not `true`.
in:formData
name:private_comment
type:string
produces:
- application/json
responses:
"200":
description:The newly created domain block, if `import` != `true`. If a list has been imported, then an `array` of newly created domain blocks will be returned instead.
schema:
$ref:'#/definitions/domainBlock'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:Create one or more domain blocks, from a string or a file.
tags:
- admin
/api/v1/admin/domain_blocks/{id}:
delete:
operationId:domainBlockDelete
parameters:
- description:The id of the domain block.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The domain block that was just deleted.
schema:
$ref:'#/definitions/domainBlock'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:Delete domain block with the given ID.
tags:
- admin
get:
operationId:domainBlockGet
parameters:
- description:The id of the domain block.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The requested domain block.
schema:
$ref:'#/definitions/domainBlock'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:View domain block with the given ID.
tags:
- admin
/api/v1/admin/media_cleanup:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description:Also cleans up unused headers + avatars from the media cache.
operationId:mediaCleanup
parameters:
- description:|-
Number of days of remote media to keep. Native values will be treated as 0.
If value is not specified, the value of media-remote-cache-days in the server config will be used.
format:int64
in:query
name:remote_cache_days
type:integer
x-go-name:RemoteCacheDays
produces:
- application/json
responses:
"200":
description:Echos the number of days requested. The cleanup is performed asynchronously after the request completes.
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- admin
summary:Clean up remote media older than the specified number of days.
tags:
- admin
/api/v1/apps:
post:
consumes:
- application/json
- application/xml
- application/x-www-form-urlencoded
description:|-
The registered application can be used to obtain an application token.
This can then be used to register a new account, or (through user auth) obtain an access token.
- description:Return only favourited statuses *OLDER* than the given favourite ID. The status with the corresponding fave ID will not be included in the response.
in:query
name:max_id
type:string
- description:Return only favourited statuses *NEWER* than the given favourite ID. The status with the corresponding fave ID will not be included in the response.
in:query
name:min_id
type:string
produces:
- application/json
responses:
"200":
description:""
headers:
Link:
description:Links to the next and previous queries.
type:string
schema:
items:
$ref:'#/definitions/status'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:favourites
summary:Get an array of statuses that the requesting account has favourited.
tags:
- favourites
/api/v1/follow_requests:
get:
description:Accounts will be sorted in order of follow request date descending (newest first).
operationId:getFollowRequests
parameters:
- default:40
description:Number of accounts to return.
in:query
name:limit
type:integer
produces:
- application/json
responses:
"200":
description:""
headers:
Link:
description:Links to the next and previous queries.
type:string
schema:
items:
$ref:'#/definitions/account'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:follows
summary:Get an array of accounts that have requested to follow you.
tags:
- follow_requests
/api/v1/follow_requests/{account_id}/authorize:
post:
description:Accept a follow request and put the requesting account in your 'followers' list.
operationId:authorizeFollowRequest
parameters:
- description:ID of the account requesting to follow you.
in:path
name:account_id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Your relationship to this account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:follows
summary:Accept/authorize follow request from the given account ID.
tags:
- follow_requests
/api/v1/follow_requests/{account_id}/reject:
post:
operationId:rejectFollowRequest
parameters:
- description:ID of the account requesting to follow you.
in:path
name:account_id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Your relationship to this account.
schema:
$ref:'#/definitions/accountRelationship'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:follows
summary:Reject/deny follow request from the given account ID.
tags:
- follow_requests
/api/v1/instance:
get:
operationId:instanceGet
produces:
- application/json
responses:
"200":
description:Instance information.
schema:
$ref:'#/definitions/instance'
"406":
description:not acceptable
"500":
description:internal error
summary:View instance information.
tags:
- instance
patch:
consumes:
- multipart/form-data
description:This requires admin permissions on the instance.
operationId:instanceUpdate
parameters:
- allowEmptyValue:true
description:Title to use for the instance.
in:formData
maximum:40
name:title
type:string
- allowEmptyValue:true
description:Username of the contact account. This must be the username of an instance admin.
in:formData
name:contact_username
type:string
- allowEmptyValue:true
description:Email address to use as the instance contact.
If filter is an empty string or not set, then `open` will be assumed as the default.
in:query
name:filter
type:string
produces:
- application/json
responses:
"200":
description:|-
If no filter parameter is provided, or filter is empty, then a legacy, Mastodon-API compatible response will be returned. This will consist of just a 'flat' array of strings like `["example.com", "example.org"]`, which corresponds to domains this instance peers with.
Domains that are silenced or suspended will also have a key `suspended_at` or `silenced_at` that contains an iso8601 date string. If one of these keys is not present on the domain object, it is open. Suspended instances may in some cases be obfuscated, which means they will have some letters replaced by `*` to make it more difficult for bad actors to target instances with harassment.
The parameters can also be given in the body of the request, as JSON, if the content-type is set to 'application/json'.
The parameters can also be given in the body of the request, as XML, if the content-type is set to 'application/xml'.
operationId:mediaUpdate
parameters:
- description:id of the attachment to update
in:path
name:id
required:true
type:string
- allowEmptyValue:true
description:Image or media description to use as alt-text on the attachment. This is very useful for users of screenreaders! May or may not be required, depending on your instance settings.
in:formData
name:description
type:string
- allowEmptyValue:true
default:0,0
description: 'Focus of the media file. If present, it should be in the form of two comma-separated floats between -1 and 1. For example:`-0.5,0.25`.'
in:formData
name:focus
type:string
produces:
- application/json
responses:
"200":
description:The newly-updated media attachment.
schema:
$ref:'#/definitions/attachment'
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:media
summary:Update a media attachment.
tags:
- media
/api/v1/notifications:
get:
description:|-
The notifications will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
- description:Return only notifications *OLDER* than the given max status ID. The status with the specified ID will not be included in the response.
in:query
name:max_id
type:string
- description:|-
Return only notifications *NEWER* than the given since status ID.
The status with the specified ID will not be included in the response.
in:query
name:since_id
type:string
produces:
- application/json
responses:
"200":
description:Array of notifications.
headers:
Link:
description:Links to the next and previous queries.
type:string
schema:
items:
$ref:'#/definitions/notification'
type:array
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:notifications
summary:Get notifications for currently authorized user.
tags:
- notifications
post:
description:Will return an empty object `{}` to indicate success.
operationId:clearNotifications
produces:
- application/json
responses:
"200":
description:""
schema:
type:object
"400":
description:bad request
"401":
description:unauthorized
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:notifications
summary:Clear/delete all notifications for currently authorized user.
tags:
- notifications
/api/v1/search:
get:
description:If statuses are in the result, they will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer).
operationId:searchGet
parameters:
- description:If type is `statuses`, then statuses returned will be authored only by this account.
The deleted status will be returned in the response. The `text` field will contain the original text of the status as it was submitted.
This is useful when doing a 'delete and redraft' type operation.
operationId:statusDelete
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The status that was just deleted.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:statuses
summary:Delete status with the given ID. The status must belong to you.
tags:
- statuses
get:
operationId:statusGet
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The requested status.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:statuses
summary:View status with the given ID.
tags:
- statuses
/api/v1/statuses/{id}/context:
get:
description:The returned statuses will be ordered in a thread structure, so they are suitable to be displayed in the order in which they were returned.
operationId:statusContext
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:Status context object.
schema:
$ref:'#/definitions/statusContext'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:statuses
summary:Return ancestors and descendants of the given status.
tags:
- statuses
/api/v1/statuses/{id}/favourite:
post:
operationId:statusFave
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The newly faved status.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:statuses
summary:Star/like/favourite the given status, if permitted.
tags:
- statuses
/api/v1/statuses/{id}/favourited_by:
get:
operationId:statusFavedBy
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:""
schema:
items:
$ref:'#/definitions/account'
type:array
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- read:accounts
summary:View accounts that have faved/starred/liked the target status.
tags:
- statuses
/api/v1/statuses/{id}/reblog:
post:
description:|-
If the target status is rebloggable/boostable, it will be shared with your followers.
This is equivalent to an ActivityPub 'Announce' activity.
operationId:statusReblog
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The boost of the status.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:statuses
summary:Reblog/boost status with the given ID.
tags:
- statuses
/api/v1/statuses/{id}/reblogged_by:
get:
operationId:statusBoostedBy
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:""
schema:
items:
$ref:'#/definitions/account'
type:array
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
security:
- OAuth2 Bearer:
- read:accounts
summary:View accounts that have reblogged/boosted the target status.
tags:
- statuses
/api/v1/statuses/{id}/unfavourite:
post:
operationId:statusUnfave
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The unfaved status.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:statuses
summary:Unstar/unlike/unfavourite the given status.
tags:
- statuses
/api/v1/statuses/{id}/unreblog:
post:
operationId:statusUnreblog
parameters:
- description:Target status ID.
in:path
name:id
required:true
type:string
produces:
- application/json
responses:
"200":
description:The unboosted status.
schema:
$ref:'#/definitions/status'
"400":
description:bad request
"401":
description:unauthorized
"403":
description:forbidden
"404":
description:not found
"406":
description:not acceptable
"500":
description:internal server error
security:
- OAuth2 Bearer:
- write:statuses
summary:Unreblog/unboost status with the given ID.
tags:
- statuses
/api/v1/streaming:
get:
description:|-
The scheme used should *always* be `wss`. The streaming basepath can be viewed at `/api/v1/instance`.
If the ping fails, or something else goes wrong during transmission, then the connection will be dropped, and the client will be expected to start it again.
operationId:streamGet
parameters:
- description:Access token for the requesting account.