diff --git a/Using-the-API/API.md b/Using-the-API/API.md index 9e790ff6..b26e7c54 100644 --- a/Using-the-API/API.md +++ b/Using-the-API/API.md @@ -12,6 +12,7 @@ API overview - [Domain blocks](#domain-blocks) - [Favourites](#favourites) - [Follow Requests](#follow-requests) + - [Follow Suggestions](#follow-suggestions) - [Follows](#follows) - [Instances](#instances) - [Lists](#lists) @@ -347,6 +348,27 @@ Returns an array of [Accounts](#account) which have requested to follow the auth Returns an empty object. +### Follow Suggestions + +#### Fetching a list of follow suggestions: + + GET /api/v1/suggestions + +Query parameters: + +| Field | Description | Optional | +| ----------------- | ------------------------------------------------------------------- | ---------- | + +> **Note:** This API does not provide pagenation. + +Returns an array of [Accounts](#account) which is suggested. + +#### Delete a user from follow suggestions: + + DELETE /api/v1/suggestions/:account_id + +Returns an empty object. + ### Follows #### Following a remote user: