Melody User Service API

user-follow-controller

Endpointhttps://melody-gateway-main-0d30d7f.d2.zuplo.dev

Follow another user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/{targetUserId}

Allows the authenticated user to follow another user by their user ID.

Follow another user › path Parameters

targetUserId

string · uuid · required

Follow another user › Responses

Successfully followed the user

POST/users/follows/{targetUserId}

curl --request POST \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/:targetUserId

shell

Example Responses

{}

plain

*/*

Unfollow a user

DELETE

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/{targetUserId}

Allows the authenticated user to unfollow another user by their user ID.

Unfollow a user › path Parameters

targetUserId

string · uuid · required

Unfollow a user › Responses

Successfully unfollowed the user

DELETE/users/follows/{targetUserId}

curl --request DELETE \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/:targetUserId

shell

Example Responses

{}

plain

*/*

Get users the authenticated user follows

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/following

Returns a list of users the authenticated user is following.

Get users the authenticated user follows › Responses

List of following users retrieved successfully

object[]

Basic user response DTO for authentication and simple operations

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

isBlocked

boolean

Indicates if the user is blocked

contentFilterEnabled

boolean

Indicates if explicit content is blocked for the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

GET/users/follows/following

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/following

shell

Example Responses

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
]

json

application/json

Get authenticated user's followers

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/followers

Returns a list of users who follow the authenticated user.

Get authenticated user's followers › Responses

List of followers retrieved successfully

object[]

Basic user response DTO for authentication and simple operations

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

isBlocked

boolean

Indicates if the user is blocked

contentFilterEnabled

boolean

Indicates if explicit content is blocked for the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

GET/users/follows/followers

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/followers

shell

Example Responses

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "user@example.com",
    "username": "johndoe",
    "role": "LISTENER",
    "region": "NAM",
    "isBlocked": false,
    "contentFilterEnabled": true,
    "createdAt": "2025-09-14T12:34:56Z"
  }
]

json

application/json

Get users the authenticated user follows

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/following/{targetUserId}

Returns a list of users the authenticated user is following.

Get users the authenticated user follows › path Parameters

targetUserId

string · uuid · required

Get users the authenticated user follows › Responses

List of following users retrieved successfully

object[]

User search result DTO with summary profile information

id

string · uuid

Unique identifier of the user

username

string

Username of the user

firstName

string

First name of the user

lastName

string

Last name of the user

role

string

Role of the user

profilePictureUrl

string

URL or path to the user's profile picture

biography

string

Biography of the user

artistName

string

Artist name when user is an artist

followersCount

integer · int32

Number of followers the user has

followingCount

integer · int32

Number of users the user is following

isFollowing

boolean

Indicates if the user is following the requester

levenshteinDistance

integer · int32

Levenshtein distance between the search query and the username (lower is better)

GET/users/follows/following/{targetUserId}

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/following/:targetUserId

shell

Example Responses

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "johndoe",
    "firstName": "John",
    "lastName": "Doe",
    "role": "ARTIST",
    "profilePictureUrl": "/images/profiles/johndoe.jpg",
    "biography": "Music lover and songwriter.",
    "artistName": "The Melody Makers",
    "followersCount": 150,
    "followingCount": 75,
    "isFollowing": true,
    "levenshteinDistance": 2
  }
]

json

application/json

Get authenticated user's followers

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/followers/{targetUserId}

Returns a list of users who follow the authenticated user.

Get authenticated user's followers › path Parameters

targetUserId

string · uuid · required

Get authenticated user's followers › Responses

List of followers retrieved successfully

object[]

User search result DTO with summary profile information

id

string · uuid

Unique identifier of the user

username

string

Username of the user

firstName

string

First name of the user

lastName

string

Last name of the user

role

string

Role of the user

profilePictureUrl

string

URL or path to the user's profile picture

biography

string

Biography of the user

artistName

string

Artist name when user is an artist

followersCount

integer · int32

Number of followers the user has

followingCount

integer · int32

Number of users the user is following

isFollowing

boolean

Indicates if the user is following the requester

levenshteinDistance

integer · int32

Levenshtein distance between the search query and the username (lower is better)

GET/users/follows/followers/{targetUserId}

curl --request GET \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/follows/followers/:targetUserId

shell

Example Responses

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "johndoe",
    "firstName": "John",
    "lastName": "Doe",
    "role": "ARTIST",
    "profilePictureUrl": "/images/profiles/johndoe.jpg",
    "biography": "Music lover and songwriter.",
    "artistName": "The Melody Makers",
    "followersCount": 150,
    "followingCount": 75,
    "isFollowing": true,
    "levenshteinDistance": 2
  }
]

json

application/json

health-controller artist-controller

Follow another user

POST

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/{targetUserId}

Allows the authenticated user to follow another user by their user ID.

Follow another user › path Parameters

targetUserId

string · uuid · required

Follow another user › Responses

Successfully followed the user

Unfollow a user

DELETE

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/{targetUserId}

Allows the authenticated user to unfollow another user by their user ID.

Unfollow a user › path Parameters

targetUserId

string · uuid · required

Unfollow a user › Responses

Successfully unfollowed the user

Get users the authenticated user follows

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/following

Returns a list of users the authenticated user is following.

Get users the authenticated user follows › Responses

List of following users retrieved successfully

object[]

Basic user response DTO for authentication and simple operations

id

string · uuid

Unique identifier of the user

email

string

Email address of the user

username

string

Username of the user

role

string · enum

Role assigned to the user

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

isBlocked

boolean

Indicates if the user is blocked

contentFilterEnabled

boolean

Indicates if explicit content is blocked for the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

Get users the authenticated user follows

GET

https://melody-gateway-main-0d30d7f.d2.zuplo.dev

/users/follows/following/{targetUserId}

Returns a list of users the authenticated user is following.

Get users the authenticated user follows › path Parameters

targetUserId

string · uuid · required

Get users the authenticated user follows › Responses

List of following users retrieved successfully

object[]

User search result DTO with summary profile information

id

string · uuid

Unique identifier of the user

username

string

Username of the user

firstName

string

First name of the user

lastName

string

Last name of the user

role

string

Role of the user

profilePictureUrl

string

URL or path to the user's profile picture

biography

string

Biography of the user

artistName

string

Artist name when user is an artist

followersCount

integer · int32

Number of followers the user has

followingCount

integer · int32

Number of users the user is following

isFollowing

boolean

Indicates if the user is following the requester

levenshteinDistance

integer · int32

Levenshtein distance between the search query and the username (lower is better)