# Mastodon API API

> Mastodon API API on Apizie: 197 endpoints (Get multiple accounts, Get all Collections from a given account, Get all Collections the current account is featured in, Get account, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/social-media:mastodon/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `social-media:mastodon`
- Category: Social Media
- Status: byok
- Source: https://mastodon
- Page: https://zieapi.vercel.app/api/social-media/mastodon
- OpenAPI: https://zieapi.vercel.app/api/social-media/mastodon/openapi.json

Unofficial documentation for the Mastodon API. Generated with [mastodon-openapi](https://github.com/abraham/mastodon-openapi) from…

## Endpoints

### Get multiple accounts
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | The IDs of the accounts. |

### Get all Collections from a given account
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | account_id parameter |
| limit | integer | no | Maximum number of results. Defaults to 40 Collections. Max 80 Collections. |
| offset | integer | no | Skip the first n results. Defaults to 0. |

### Get all Collections the current account is featured in
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-in-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | account_id parameter |
| limit | integer | no | Maximum number of results. Defaults to 40 Collections. Max 80 Collections. |
| offset | integer | no | Skip the first n results. Defaults to 0. |

### Get account
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Block account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-block` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Feature account on your profile
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-endorse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Get featured accounts
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-endorsements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Get account's featured tags
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-featured-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Follow account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-follow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | JSON request body |

### Get account's followers
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Get account's following
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-following` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Get lists containing this account
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Mute account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-mute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | JSON request body |

### Set private note on profile
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | JSON request body |

### Remove account from followers
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-remove-from-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Get account's statuses
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-statuses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| exclude_reblogs | boolean | no | Filter out boosts from the response. |
| exclude_replies | boolean | no | Filter out statuses in reply to a different account. |
| limit | integer | no | Maximum number of results to return. Defaults to 20 statuses. Max 40 statuses. |
| max_id | string | no | All results returned will be lesser than this ID. In effect, sets an upper bound on results. |
| min_id | string | no | Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward. |
| only_media | boolean | no | Filter out statuses without attachments. |
| pinned | boolean | no | Filter for pinned statuses only. Defaults to false, which includes all statuses. Pinned statuses do not receive special priority in the… |
| since_id | string | no | All results returned will be greater than this ID. In effect, sets a lower bound on results. |
| tagged | string | no | Filter for statuses using a specific hashtag. |

### Unblock account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-unblock` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Unfeature account from profile
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-unendorse` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Unfollow account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-unfollow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Unmute account
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-account-unmute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Find familiar followers
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-familiar-followers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Find familiar followers for the provided account IDs. |

### Lookup account ID from WebFinger address
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-lookup` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| acct | string | yes | The username or WebFinger address to lookup. |

### Check relationships to other accounts
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-relationships` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | Check relationships for the provided account IDs. |
| with_suspended | boolean | no | Whether relationships should be returned for suspended users, defaults to false. |

### Search for matching accounts
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | yes | Search query for accounts. |
| following | boolean | no | Limit the search to users you are following. Defaults to false. |
| limit | integer | no | Maximum number of results. Defaults to 40 accounts. Max 80 accounts. |
| offset | integer | no | Skip the first n results. |
| resolve | boolean | no | Attempt WebFinger lookup. Defaults to false. Use this when `q` is an exact address. |

### Update account credentials
`POST https://zieapi.vercel.app/v1/social-media:mastodon/patch-account-update-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Verify account credentials
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-account-verify-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| allow_nonfunctional | boolean | no | Whether to get account information even if the account is non-functional (such as e.g. not being approved or confirmed), defaults to… |

### View all announcements
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-announcements` (byok)

### Dismiss an announcement
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-announcement-dismiss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Add a reaction to an announcement
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-announcement-reaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| name | string | yes | name parameter |

### Remove a reaction from an announcement
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-announcement-reaction` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| name | string | yes | name parameter |

### Get all annual reports
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-annual-reports` (byok)

### Get a single annual report
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-annual-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| year | string | yes | year parameter |

### Generate a new annual report {generate}
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-annual-report-generate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| year | string | yes | year parameter |

### Mark an annual report as read
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-annual-report-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| year | string | yes | year parameter |

### Get the state of an annual report
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-annual-report-state` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| year | string | yes | year parameter |

### Create an application
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Verify your app works
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-app-verify-credentials` (byok)

### Get Status of Async Refresh
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-async-refresh-v1-alpha` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View blocked users
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-blocks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### View bookmarked statuses
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-bookmarks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 20 statuses. Max 40 statuses. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Create a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Add an account to a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-collection-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | collection_id parameter |
| body | object | no | JSON request body |

### Remove account from a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-collection-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | collection_id parameter |
| id | string | yes | id parameter |

### Revoke inclusion in a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-collection-item-revoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collection_id | string | yes | collection_id parameter |
| id | string | yes | id parameter |

### Get a single Collection
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Update a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | JSON request body |

### Delete a Collection
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View all conversations
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 20 conversations. Max 40 conversations. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Remove a conversation
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Mark a conversation as read
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-conversation-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View all custom emoji
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-custom-emojis` (byok)

### View profile directory
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-directory` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | How many accounts to load. Defaults to 40 accounts. Max 80 accounts. |
| local | boolean | no | If true, returns only local accounts. |
| offset | integer | no | Skip the first n results. |
| order | string | no | Use `active` to sort by most recently posted statuses (default) or `new` to sort by most recently created profiles. |

### Get domain blocks
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-domain-blocks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 100 domain blocks. Max 200 domain blocks. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Block a domain
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-domain-block` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Unblock a domain
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-domain-blocks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Resend confirmation email
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-email-confirmations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### View currently featured profiles
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-endorsements` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### View favourited statuses
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-favourites` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 20 statuses. Max 40 statuses. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### View your featured tags
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-featured-tags` (byok)

### Feature a tag
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-featured-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Unfeature a tag
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-featured-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View suggested tags to feature
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-featured-tag-suggestions` (byok)

### View all filters
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filters-v2` (byok)

### Create a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-filter-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### View keywords added to a filter
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filter-keywords-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter_id | string | yes | filter_id parameter |

### Add a keyword to a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-filter-keywords-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter_id | string | yes | filter_id parameter |
| body | object | yes | JSON request body |

### View all status filters
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filter-statuses-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter_id | string | yes | filter_id parameter |

### Add a status to a filter group
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-filter-statuses-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| filter_id | string | yes | filter_id parameter |
| body | object | yes | JSON request body |

### View a specific filter
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filter-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Update a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-filter-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | JSON request body |

### Delete a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-filter-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View a single keyword
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filter-keyword-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Edit a keyword within a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-filter-keyword-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | yes | JSON request body |

### Remove keywords from a filter
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-filter-keyword-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View a single status filter
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-filter-status-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Remove a status from a filter group
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-filter-status-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View pending follow requests
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-follow-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Accept follow request
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-follow-request-authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | account_id parameter |

### Reject follow request
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-follow-request-reject` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | account_id parameter |

### View all followed tags
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-followed-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 100 tags. Max 200 tags. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Get basic health status as JSON
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-health` (byok)

### Weekly activity
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-activity` (byok)

### View moderated servers
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-domain-blocks` (byok)

### View extended description
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-extended-description` (byok)

### List of connected domains
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-peers` (byok)

### View privacy policy
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-privacy-policy` (byok)

### List of rules
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-rules` (byok)

### View terms of service
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-terms-of-service` (byok)

### View a specific version of the terms of service
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-terms-of-service-by-date` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| date | string | yes | date parameter |

### View translation languages
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-translation-languages` (byok)

### View server information
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-instance-v2` (byok)

### View your lists
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-lists` (byok)

### Create a list
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Show a single list
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Update a list
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | yes | JSON request body |

### Delete a list
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### View accounts in a list
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| limit | integer | no | Maximum number of results. Defaults to 40 accounts. Max 80 accounts. Set to 0 in order to get all accounts without pagination. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| min_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Add accounts to a list
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | yes | JSON request body |

### Remove accounts from list
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-list-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | yes | JSON request body |

### Get saved timeline positions
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-markers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeline | array | no | Specify the timeline(s) for which markers should be fetched. Possible values: `home`, `notifications`. If not provided, an empty object… |

### Save your position in a timeline
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-marker` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get media attachment
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Update media attachment
`POST https://zieapi.vercel.app/v1/social-media:mastodon/update-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| body | object | no | Form fields as a JSON object |

### Delete media attachment
`POST https://zieapi.vercel.app/v1/social-media:mastodon/delete-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Upload media as an attachment (async)
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-media-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### View muted accounts
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-mutes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 40 accounts. Max 80 accounts. |
| max_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |
| since_id | string | no | Internal parameter. Use HTTP `Link` header for pagination. |

### Get all notifications
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | no | Return only notifications received from the specified account. |
| exclude_types | array | no | Types to exclude from the results. |
| include_filtered | boolean | no | Whether to include notifications filtered by the user's [NotificationPolicy]. Defaults to false. |
| limit | integer | no | Maximum number of results to return. Defaults to 40 notifications. Max 80 notifications. |
| max_id | string | no | All results returned will be lesser than this ID. In effect, sets an upper bound on results. |
| min_id | string | no | Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward. |
| since_id | string | no | All results returned will be greater than this ID. In effect, sets a lower bound on results. |
| supported_types | array | no | Notification types to not get fallback representation for even when some is available. Passing this parameter is required to get any… |
| types | array | no | Types to include in the result. |

### Get a single notification
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |
| supported_types | array | no | Notification types to not get fallback representation for even when some is available. Passing this parameter is required to get any… |

### Dismiss a single notification
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-notification-dismiss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Dismiss all notifications
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-notification-clear` (byok)

### Get all notification requests
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification-requests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | Maximum number of results to return. Defaults to 40 notification requests. Max 80 notification requests. |
| max_id | string | no | All results returned will be lesser than this ID. In effect, sets an upper bound on results. |
| min_id | string | no | Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward. |
| since_id | string | no | All results returned will be greater than this ID. In effect, sets a lower bound on results. |

### Get a single notification request
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification-request` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Accept a single notification request
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-notification-request-accept` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Dismiss a single notification request
`POST https://zieapi.vercel.app/v1/social-media:mastodon/post-notification-request-dismiss` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | id parameter |

### Accept multiple notification requests
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-notification-request-accept` (byok)

### Dismiss multiple notification requests
`POST https://zieapi.vercel.app/v1/social-media:mastodon/create-notification-request-dismiss` (byok)

### Check if accepted notification requests have been merged
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification-request-merged` (byok)

### Get the number of unread notifications
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification-unread-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | no | Only count unread notifications received from the specified account. |
| exclude_types | array | no | Types of notifications that should not count towards unread notifications. |
| limit | integer | no | Maximum number of results to return. Defaults to 100 notifications. Max 1000 notifications. |
| types | array | no | Types of notifications that should count towards unread notifications. |

### Get all grouped notifications
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notifications-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | no | Return only notifications received from the specified account. |
| exclude_types | array | no | Types to exclude from the results. |
| expand_accounts | string | no | One of `full` (default) or `partial_avatars`. When set to `partial_avatars`, some accounts will not be rendered in full in the returned… |
| grouped_types | array | no | Restrict which notification types can be grouped. Use this if there are notification types for which your client does not support… |
| include_filtered | boolean | no | Whether to include notifications filtered by the user's [NotificationPolicy]. Defaults to false. |
| limit | integer | no | Maximum number of results to return. Defaults to 40 notifications. Max 80 notification groups. |
| max_id | string | no | All results returned will be about notifications strictly older than this notification ID. In effect, sets an upper bound on results. |
| min_id | string | no | Returns results about notifications immediately newer than this notification ID. In effect, sets a cursor at this ID and paginates forward. |
| since_id | string | no | All results returned will be about notifications strictly newer than this notification ID. In effect, sets a lower bound on results. |
| supported_types | array | no | Notification types to not get fallback representation for even when some is available. Passing this parameter is required to get any… |
| types | array | no | Types to include in the result. |

### Get a single notification group
`GET https://zieapi.vercel.app/v1/social-media:mastodon/get-notification-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group_key | string | yes | group_key parameter |
| supported_types | array | no | Notification types to not get fallback representation for even when some is available. Passing this parameter is required to get any… |

…and 77 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/social-media:mastodon/get-accounts" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Mastodon API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/social-media:mastodon/get-accounts with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Mastodon API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Mastodon API itself also needs your own key from mastodon.

### Can AI agents use the Mastodon API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key social-media:mastodon.

### What is the status of the Mastodon API API?
Needs your own provider key (bring your own key)