follow_requests

View and manage follow requests.

Pending Follows

GET https://mastodon.example/api/v1/follow_requests

Returns: Array of Account OAuth: User token + read:follows or follow Version history: 0.0.0 - added

Query Parameters

Name	Type	Description
limit	string	Maximum number of results to return. Defaults to 40. Paginate using the HTTP Link header.

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200 Accounts that are requesting a follow

Link: <https://mastodon.social/api/v1/follow_requests?max_id=23716836>; rel="next", <https://mastodon.social/api/v1/follow_requests?min_id=23716978>; rel="prev"

[
  {
    "id": "8889777",
    "username": "example",
    "acct": "[e-mail]",
    ...
  }
]

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

Accept Follow

POST https://mastodon.example/api/v1/follow_requests/:id/authorize

Returns: Relationship OAuth: User token + write:follows or follow Version history: 0.0.0 - added 3.0.0 - now returns Relationship instead of nothing

Path Parameters

Name	Type	Description
:id	string	ID of the account in the database

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200 Your Relationship with this account should be updated so that you are followed_by this account.

{
  "id": "8889777",
  "following": false,
  "showing_reblogs": false,
  "followed_by": true,
  "blocking": false,
  "blocked_by": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "endorsed": false
}

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

404 No pending follow request from that user ID

{
  "error": "Record not found"
}

Reject Follow

POST https://mastodon.example/api/v1/follow_requests/:id/reject

Returns: Relationship OAuth: User token + write:follows or follow Version history: 0.0.0 - added 3.0.0 - now returns Relationship instead of nothing

Path Parameters

Name	Type	Description
:id	string	ID of the account in the database

Headers

Name	Type	Description
Authorization	string	Bearer <user token>

200 Your Relationship with this Account should be unchanged.

{
  "id": "8889777",
  "following": false,
  "showing_reblogs": false,
  "followed_by": false,
  "blocking": false,
  "blocked_by": false,
  "muting": false,
  "muting_notifications": false,
  "requested": false,
  "domain_blocking": false,
  "endorsed": false
}

401 Invalid or missing Authorization header

{
  "error": "The access token is invalid"
}

404 No pending follow request for that user ID

{
  "error": "Record not found"
}