GET
/
users
/
suggested
Get suggested users
curl --request GET \
  --url https://localhost:5000/users/suggested \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "users": [
    {
      "name": "<string>",
      "username": "<string>",
      "email": "jsmith@example.com",
      "_id": "<string>",
      "image": "<string>",
      "bio": "<string>",
      "gender": "<string>",
      "emailVerified": true,
      "followers": [
        "<string>"
      ],
      "following": [
        "<string>"
      ],
      "bookmarks": [
        "<string>"
      ],
      "blocked_users": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "mutualFollowers": [
        {
          "name": "<string>",
          "username": "<string>",
          "email": "jsmith@example.com",
          "_id": "<string>",
          "image": "<string>",
          "bio": "<string>",
          "gender": "<string>",
          "emailVerified": true,
          "followers": [
            "<string>"
          ],
          "following": [
            "<string>"
          ],
          "bookmarks": [
            "<string>"
          ],
          "blocked_users": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "followerBy": [
        {
          "name": "<string>",
          "username": "<string>",
          "email": "jsmith@example.com",
          "_id": "<string>",
          "image": "<string>",
          "bio": "<string>",
          "gender": "<string>",
          "emailVerified": true,
          "followers": [
            "<string>"
          ],
          "following": [
            "<string>"
          ],
          "bookmarks": [
            "<string>"
          ],
          "blocked_users": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

List of suggested users

​
success
boolean
Example:

true

​
users
object[]