Get Follow Status
Endpoint
URL: api.replyke.com/api/v6/:projectId/users/:userId/follow
Method: GET
Authentication Required: Yes
Description
Check if the current user follows the specified user and get follow relationship details.
Request
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
userId | string | Yes | ID of the user to check follow status with |
Headers
Header | Type | Required | Description |
---|---|---|---|
Authorization | string | Yes | Bearer token for authentication. |
Body Parameters
None
Example Request
GET /users/user-uuid-123/follow
Authorization: Bearer <ACCESS_TOKEN>
Response
Success Responses
Following User (200 OK)
{
"isFollowing": true,
"followId": "follow-uuid",
"followedAt": "2024-01-01T12:00:00.000Z"
}
Not Following User (200 OK)
{
"isFollowing": false
}
Error Responses
Invalid User ID (400 Bad Request)
{
"error": "Invalid userId",
"code": "follow/invalid-user-id"
}
Self-Check Attempt (400 Bad Request)
{
"error": "Cannot check follow status with yourself",
"code": "follow/self-follow"
}
Server Error (500 Internal Server Error)
{
"error": "Internal server error",
"code": "follow/server-error"
}
Notes
- This endpoint checks if a follow relationship exists between the authenticated user and the target user
- Returns additional follow details when following (followId and followedAt timestamp)
- Cannot check follow status with yourself
- Rate limiting: 100 requests per 5 minutes