Mastodon
  • User guide
    • Basics
    • Decentralization
    • Privacy
    • Moderation
  • Administrator guide
    • Installation
    • Configuration
    • Post-installation steps
    • Scaling up
    • Optional features
    • Upgrading to a new release
    • Migrating servers
    • Troubleshooting
  • Development guide
    • Overview
    • ActivityPub compliance
  • API Overview
    • Guidelines
    • Libraries
    • Authentication
    • Permissions
    • Entities
    • Parameters
    • Streaming API
    • Web Push API
  • REST API
    • Accounts
    • Apps
    • Blocks
    • Custom emoji
    • Domain blocks
    • Endorsements
    • Favourites
    • Filters
    • Follow requests
    • Follow suggestions
    • Instances
    • Lists
    • Media attachments
    • Mutes
    • Notifications
    • Reports
    • Scheduled Statuses
    • Search
    • Statuses
    • Timelines

Endorsements

    • GET /api/v1/endorsements
      • Resource information
      • Pagination
    • POST /api/v1/accounts/:id/pin
      • Resource information
    • POST /api/v1/accounts/:id/unpin
      • Resource information

GET /api/v1/endorsements

Accounts the user chose to endorse.

Returns array of Account

Resource information

Response format JSON
Requires authentication Yes
Requires user Yes
Scope read read:account
Available since 2.5.0

Pagination

This API returns Link headers containing links to the next and previous page. Since it is using an internal ID, it is not possible to dynamically generate query parameters to paginate. You must rely on the Link header.

POST /api/v1/accounts/:id/pin

Endorse an account, i.e. choose to feature the account on the user’s public profile.

Returns Relationship

Resource information

Response format JSON
Requires authentication Yes
Requires user Yes
Scope write write:accounts
Available since 2.5.0

POST /api/v1/accounts/:id/unpin

Undo endorse of an account.

Returns Relationship

Resource information

Response format JSON
Requires authentication Yes
Requires user Yes
Scope write write:accounts
Available since 2.5.0

Last updated January 20, 2019 · Improve this page

Merch

T-shirts and stickers

Join Mastodon · Find Twitter friends · Blog · · ·

View source · CC BY-SA 4.0 · Imprint