Friends API
All endpoints require authentication. Base path: /api/v1/friends.
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| GET | /v1/friends | List accepted friends |
| GET | /v1/friends/requests | List pending friend requests (incoming and outgoing) |
| POST | /v1/friends/requests | Send a friend request (receiver_id) |
| PUT | /v1/friends/requests/{friendRequest}/accept | Accept a friend request (receiver only) |
| PUT | /v1/friends/requests/{friendRequest}/reject | Reject a friend request (receiver only) |
List Requests
Section titled “List Requests”GET /v1/friends/requestsReturns pending incoming and outgoing friend requests with their statuses (pending/accepted/rejected).
Send Request
Section titled “Send Request”POST /v1/friends/requests| Field | Type | Rules |
|---|---|---|
receiver_id | string | Required. ID of the user to befriend |
Accept / Reject
Section titled “Accept / Reject”PUT /v1/friends/requests/{friendRequest}/acceptPUT /v1/friends/requests/{friendRequest}/rejectOnly the receiver can accept or reject a request. No request body needed.