follow_requests

View and manage follow requests.

get
Pending Follows

https://CounterSocial.example/api/v1/follow_requests

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

Request

Headers
Authorization
required
string
Bearer
Query Parameters
limit
optional
string
Maximum number of results to return. Defaults to 40. Paginate using the HTTP Link header.

Response

200: Success

Accounts that are requesting a follow

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

[
  {
    "id": "8889777",
    "username": "example",
    "acct": "[email protected]",
    ...
  }
]

401: Unauthorized

Invalid or missing Authorization header

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

post
Accept Follow

https://CounterSocial.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

Request

Path Parameters
:id
optional
string
ID of the account in the database
Headers
Authorization
required
string
Bearer

Response

200: Success

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: Unauthorized

Invalid or missing Authorization header

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

404: Not Found

No pending follow request from that user ID

{
  "error": "Record not found"
}

post
Reject Follow

https://CounterSocial.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

Request

Path Parameters
:id
optional
string
ID of the account in the database
Headers
Authorization
required
string
Bearer

Response

200: Success

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: Unauthorized

Invalid or missing Authorization header

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

404: Not Found

No pending follow request for that user ID

{
  "error": "Record not found"
}

Last updated December 27, 2020 ?? Improve this page