Skip to content
Capturit Backend Docs

List of Friends

GET api/friend/list

This is used to retrieve a user’s list of friends.

Example Request

Terminal window
curl -X 'GET' \
  'http://localhost:8080/api/friend/list?page=<page>&page_length=<page_length>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Parameters

filter_by

Type: Query
Data Type: Integer
Required: Yes
Description: Specifies the criteria to filter the list
Values:

  • Friend Requests - 1

page

Type: Query
Data Type: Integer
Required: Yes
Description: The current page number in the pagination

page_length

Type: Query
Data Type: Integer
Required: Yes
Description: The number of items displayed per page in the pagination

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Minimal Users

{
  "current_page": 0,
  "data": [
    {
        "id": 0,
        "user_first_name": "string",
        "user_middle_name": "string",
        "user_last_name": "string",
        "user_username": "string",
        "user_avatar_url": "string",
        "user_visible": "string"
    }
  ],
  "first_page_url": "string",
  "from": 0,
  "next_page_url": "string",
  "path": "string",
  "per_page": "string",
  "prev_page_url": "string",
  "to": 0
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

{
  "param_name": [
    "string"
  ],
  "param_name_2": [
    "string"
  ]
}

401 - Unauthorized

The request requires valid bearer token, but none were provided, or the bearer token is invalid.

429 - Too Many Requests

The user has exceeded the rate limit of 120 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.