Follow requests

GET /api/follow-requests

Get follow requests to process, received by authenticated user.

Scope: follow:read

Example requests:

  • without parameters

GET /api/follow-requests/ HTTP/1.1

  • with some query parameters

GET /api/follow-requests?page=1&order=desc  HTTP/1.1

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "data": {
    "follow_requests": [
      {
        "admin": false,
        "bio": null,
        "birth_date": null,
        "created_at": "Thu, 02 Dec 2021 17:50:48 GMT",
        "first_name": null,
        "followers": 1,
        "following": 1,
        "last_name": null,
        "location": null,
        "nb_sports": 0,
        "nb_workouts": 0,
        "picture": false,
        "records": [],
        "sports_list": [],
        "total_distance": 0.0,
        "total_duration": "0:00:00",
        "username": "Sam"
      }
    ]
  },
  "pagination": {
    "has_next": false,
    "has_prev": false,
    "page": 1,
    "pages": 1,
    "total": 1
  },
  "status": "success"
}
Query Parameters:

  • page (integer) – page if using pagination (default: 1)

  • per_page (integer) – number of follow requests per page (default: 10, max: 50)

  • order (string) – sorting order (default: asc)

Request Headers:
Status Codes:
POST /api/follow-requests/(user_name)/accept

Accept a follow request from user.

Scope: follow:write

Example requests:

POST /api/follow-requests/Sam/accept HTTP/1.1

Example responses:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "message": "Follow request from user 'Sam' is accepted.",
}
Parameters:

  • user_name (string) – user name

Request Headers:
Status Codes:

  • 200 OK – success

  • 401 Unauthorized –

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again

  • 400 Bad Request –

    • Follow request from user 'user_name' already accepted.

  • 403 Forbidden –

    • you do not have permissions, your account is suspended

  • 404 Not Found –

    • user does not exist

    • Follow request does not exist.

POST /api/follow-requests/(user_name)/reject

Reject a follow request from user.

Scope: follow:write

Example requests:

POST /api/follow-requests/Sam/reject HTTP/1.1

Example responses:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "status": "success",
  "message": "Follow request from user 'Sam' is rejected.",
}
Parameters:

  • user_name (string) – user name

Request Headers:
Status Codes:

  • 200 OK – success

  • 401 Unauthorized –

    • provide a valid auth token

    • signature expired, please log in again

    • invalid token, please log in again

  • 400 Bad Request –

    • Follow request from user 'user_name' already rejected.

  • 403 Forbidden –

    • you do not have permissions, your account is suspended

  • 404 Not Found –

    • user does not exist

    • Follow request does not exist.