Skip to content
Vidivo Docs

Follow

The Follow API allows users to follow hosts. Followers receive broadcast messages from hosts and appear in the host’s follower list. All follow endpoints require authentication.

POST /v1/users/:id/follow

Section titled “POST /v1/users/:id/follow”

Follow a host. The authenticated user starts following the user specified by :id.

Authentication: Bearer token required.

Request

Section titled “Request”
POST /v1/users/01JN2X4K8M3F7QPZRVWT6YBHCE/follow
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...

Response

Section titled “Response”
HTTP/1.1 201 Created
{
  "follower_id": "01JN2XF5G6H7I8J9K0L1M2N3O4",
  "followed_id": "01JN2X4K8M3F7QPZRVWT6YBHCE",
  "created_at": "2026-03-15T10:00:00Z"
}

Errors

Section titled “Errors”
CodeStatusDescription
conflict409Already following this user
validation_error400Cannot follow yourself
not_found404Target user does not exist

DELETE /v1/users/:id/follow

Section titled “DELETE /v1/users/:id/follow”

Unfollow a user. The authenticated user stops following the user specified by :id.

Authentication: Bearer token required.

Request

Section titled “Request”
DELETE /v1/users/01JN2X4K8M3F7QPZRVWT6YBHCE/follow
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...

Response

Section titled “Response”
HTTP/1.1 204 No Content

Errors

Section titled “Errors”
CodeStatusDescription
not_found404Not following this user

GET /v1/users/:id/follow-status

Section titled “GET /v1/users/:id/follow-status”

Check whether the authenticated user is following the user specified by :id.

Authentication: Bearer token required.

Request

Section titled “Request”
GET /v1/users/01JN2X4K8M3F7QPZRVWT6YBHCE/follow-status
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...

Response

Section titled “Response”
{
  "is_following": true,
  "followed_at": "2026-03-15T10:00:00Z"
}

GET /v1/users/:id/followers

Section titled “GET /v1/users/:id/followers”

List the followers of a user. Paginated.

Authentication: Bearer token required.

Request

Section titled “Request”
GET /v1/users/01JN2X4K8M3F7QPZRVWT6YBHCE/followers?page=1&per_page=20
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...

Response

Section titled “Response”
{
  "success": true,
  "data": [
    {
      "id": "01JN2XF5G6H7I8J9K0L1M2N3O4",
      "display_name": "Alex Johnson",
      "avatar_url": "https://cdn.vidivo.app/avatars/01JN2XF5.jpg",
      "followed_at": "2026-03-15T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 42,
    "total_pages": 3
  }
}

GET /v1/users/me/following

Section titled “GET /v1/users/me/following”

List the hosts that the authenticated user is following.

Authentication: Bearer token required.

Request

Section titled “Request”
GET /v1/users/me/following?page=1&per_page=20
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9...

Response

Section titled “Response”
{
  "success": true,
  "data": [
    {
      "id": "01JN2X4K8M3F7QPZRVWT6YBHCE",
      "display_name": "Jane Smith",
      "username": "janecoach",
      "avatar_url": "https://cdn.vidivo.app/avatars/01JN2X4K.jpg",
      "is_available": true,
      "followed_at": "2026-03-15T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 3,
    "total_pages": 1
  }
}