Melody User Service API

user-controller

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

Get current user profile

GET

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

/users/me

Returns the profile information of the authenticated user

Get current user profile › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

favoriteGenreIds

string[] · unique

User's favorite genres selected at onboarding

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtistIds

string[] · unique

User's favorite artists selected at onboarding

followedArtists

string[] · unique

Artist being followed by the user

GET/users/me

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  },
  "favoriteGenreIds": [
    "ROCK"
  ],
  "favoriteArtistIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "followedArtists": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

application/json

Update current user profile

PATCH

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

/users/me

Updates the profile information of the authenticated user. Only provided fields will be updated.

Update current user profile › Request Body

Request object for updating user profile

firstName

string · minLength: 0 · maxLength: 50

User's first name

lastName

string · minLength: 0 · maxLength: 50

User's last name

phoneNumber

string · pattern: ^$|^\+?[0-9]{10,15}$

User's phone number

address

string · minLength: 0 · maxLength: 200

User's physical address

profilePictureUrl

string

URL to the user's profile picture

bio

string · minLength: 0 · maxLength: 500

User's biography

contentFilterEnabled

boolean

Content filter preference

region

string

User region

Update current user profile › Responses

Profile updated successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

PATCH/users/me

curl --request PATCH \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Smith",
  "phoneNumber": "+541112345678",
  "address": "456 Oak Street, Buenos Aires, Argentina",
  "profilePictureUrl": "https://example.com/profiles/john-smith.jpg",
  "bio": "New bio",
  "contentFilterEnabled": true
}
'

shell

Example Request Body

{
  "firstName": "John",
  "lastName": "Smith",
  "phoneNumber": "+541112345678",
  "address": "456 Oak Street, Buenos Aires, Argentina",
  "profilePictureUrl": "https://example.com/profiles/john-smith.jpg",
  "bio": "New bio",
  "contentFilterEnabled": true
}

json

Update profile example

application/json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

Update onboarding fields for current user

PATCH

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

/users/me/onboarding

Updates onboarding-related fields (role, artist name, favorite genres, favorite artists) for the authenticated user. Only provided fields will be updated.

Update onboarding fields for current user › Request Body

Request object for onboarding fields update

region

string · required

User region

role

string · enum

User role type

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

artistName

string

Artist's display name (only for ARTIST)

favoriteGenres

string[]

Set of user's favorite genres

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtists

string[]

Set of favorite artist UUIDs

Update onboarding fields for current user › Responses

Onboarding fields updated successfully

Response object for onboarding fields

id

string · uuid

User UUID

email

string

User email

username

string

Username

role

string · enum

User role type

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

artistName

string

Artist's display name (only for ARTIST)

favoriteGenres

string[]

List of user's favorite genres

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtists

string[]

List of favorite artist UUIDs

PATCH/users/me/onboarding

curl --request PATCH \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/me/onboarding \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "ROCK",
    "AMBIENT"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}
'

shell

Example Request Body

{
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "ROCK",
    "AMBIENT"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}

json

Update onboarding example

application/json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "Rock",
    "Jazz"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}

json

application/json

Get another user's profile by ID

GET

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

/users/{userId}

Returns the profile information of the specified user by their ID

Get another user's profile by ID › path Parameters

userId

string · uuid · required

Get another user's profile by ID › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

GET/users/{userId}

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

Search users

GET

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

/users/search

Search users by username, first name, last name, or full name. Supports pagination.

Search users › query Parameters

query

string · required

Search term (username, name, last name, full name)

page

integer · int32

Page number (starts at 0)

Default: 0

size

integer · int32

Results per page

Default: 20

includeListeners

boolean

Default: true

includeArtists

boolean

Default: true

Search users › Responses

Search results page

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/search

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/search?query=%3Cstring%3E'

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 another user's profile by ID for internal use

GET

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

/users/internal/{userId}

Returns the profile information of the specified user by their ID

Get another user's profile by ID for internal use › path Parameters

userId

string · uuid · required

Get another user's profile by ID for internal use › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

GET/users/internal/{userId}

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

auth-controller health-controller

Melody User Service API

user-controller

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

Get current user profile

GET

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

/users/me

Returns the profile information of the authenticated user

Get current user profile › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

favoriteGenreIds

string[] · unique

User's favorite genres selected at onboarding

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtistIds

string[] · unique

User's favorite artists selected at onboarding

followedArtists

string[] · unique

Artist being followed by the user

GET/users/me

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  },
  "favoriteGenreIds": [
    "ROCK"
  ],
  "favoriteArtistIds": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "followedArtists": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

json

application/json

Update current user profile

PATCH

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

/users/me

Updates the profile information of the authenticated user. Only provided fields will be updated.

Update current user profile › Request Body

Request object for updating user profile

firstName

string · minLength: 0 · maxLength: 50

User's first name

lastName

string · minLength: 0 · maxLength: 50

User's last name

phoneNumber

string · pattern: ^$|^\+?[0-9]{10,15}$

User's phone number

address

string · minLength: 0 · maxLength: 200

User's physical address

profilePictureUrl

string

URL to the user's profile picture

bio

string · minLength: 0 · maxLength: 500

User's biography

contentFilterEnabled

boolean

Content filter preference

region

string

User region

Update current user profile › Responses

Profile updated successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

PATCH/users/me

curl --request PATCH \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/me \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Smith",
  "phoneNumber": "+541112345678",
  "address": "456 Oak Street, Buenos Aires, Argentina",
  "profilePictureUrl": "https://example.com/profiles/john-smith.jpg",
  "bio": "New bio",
  "contentFilterEnabled": true
}
'

shell

Example Request Body

{
  "firstName": "John",
  "lastName": "Smith",
  "phoneNumber": "+541112345678",
  "address": "456 Oak Street, Buenos Aires, Argentina",
  "profilePictureUrl": "https://example.com/profiles/john-smith.jpg",
  "bio": "New bio",
  "contentFilterEnabled": true
}

json

Update profile example

application/json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

Update onboarding fields for current user

PATCH

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

/users/me/onboarding

Updates onboarding-related fields (role, artist name, favorite genres, favorite artists) for the authenticated user. Only provided fields will be updated.

Update onboarding fields for current user › Request Body

Request object for onboarding fields update

region

string · required

User region

role

string · enum

User role type

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

artistName

string

Artist's display name (only for ARTIST)

favoriteGenres

string[]

Set of user's favorite genres

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtists

string[]

Set of favorite artist UUIDs

Update onboarding fields for current user › Responses

Onboarding fields updated successfully

Response object for onboarding fields

id

string · uuid

User UUID

email

string

User email

username

string

Username

role

string · enum

User role type

Enum values:

LISTENER

ARTIST

UNDECLARED

ADMIN

region

string

User region

artistName

string

Artist's display name (only for ARTIST)

favoriteGenres

string[]

List of user's favorite genres

Enum values:

ROCK

ALTERNATIVE_ROCK

INDIE_ROCK

HARD_ROCK

PUNK_ROCK

POP

INDIE_POP

ELECTROPOP

favoriteArtists

string[]

List of favorite artist UUIDs

PATCH/users/me/onboarding

curl --request PATCH \
  --url https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/me/onboarding \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "ROCK",
    "AMBIENT"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}
'

shell

Example Request Body

{
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "ROCK",
    "AMBIENT"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}

json

Update onboarding example

application/json

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "ARTIST",
  "region": "NAM",
  "artistName": "The Melody Makers",
  "favoriteGenres": [
    "Rock",
    "Jazz"
  ],
  "favoriteArtists": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "7ca21f64-1234-4562-b3fc-2c963f66abc9"
  ]
}

json

application/json

Get another user's profile by ID

GET

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

/users/{userId}

Returns the profile information of the specified user by their ID

Get another user's profile by ID › path Parameters

userId

string · uuid · required

Get another user's profile by ID › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

GET/users/{userId}

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

Search users

GET

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

/users/search

Search users by username, first name, last name, or full name. Supports pagination.

Search users › query Parameters

query

string · required

Search term (username, name, last name, full name)

page

integer · int32

Page number (starts at 0)

Default: 0

size

integer · int32

Results per page

Default: 20

includeListeners

boolean

Default: true

includeArtists

boolean

Default: true

Search users › Responses

Search results page

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/search

curl --request GET \
  --url 'https://melody-gateway-main-0d30d7f.d2.zuplo.dev/users/search?query=%3Cstring%3E'

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 another user's profile by ID for internal use

GET

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

/users/internal/{userId}

Returns the profile information of the specified user by their ID

Get another user's profile by ID for internal use › path Parameters

userId

string · uuid · required

Get another user's profile by ID for internal use › Responses

Profile retrieved successfully

Detailed user profile response DTO with comprehensive profile information

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

firstName

string

First name of the user

lastName

string

Last name of the user

phoneNumber

string

Phone number of the user

address

string

Address of the user

isFollowed

boolean

Indicates if the user is being followed by the requester

isFollowing

boolean

Indicates if the user is following the requester

followersCount

integer · int64

Number of followers the user has

followingCount

integer · int64

Number of users the user is following

profilePictureUrl

string

URL or path to the user's profile picture

bio

string

Short biography or description of the user

createdAt

string · date-time

Creation timestamp in ISO-8601 UTC format

object

Response object containing artist profile information

GET/users/internal/{userId}

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

shell

Example Responses

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "email": "user@example.com",
  "username": "johndoe",
  "role": "LISTENER",
  "region": "NAM",
  "isBlocked": false,
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+1234567890",
  "address": 123,
  "isFollowed": true,
  "isFollowing": false,
  "followersCount": 150,
  "followingCount": 75,
  "profilePictureUrl": "/images/profiles/johndoe.jpg",
  "bio": "Music lover and guitarist",
  "createdAt": "2025-09-14T12:34:56Z",
  "artistProfile": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "artistName": "The Weeknd",
    "bio": "Grammy Award winning artist",
    "bannerImageUrl": "https://example.com/banner.jpg",
    "instagramUrl": "https://instagram.com/theweeknd",
    "facebookUrl": "https://facebook.com/theweeknd",
    "twitterUrl": "https://twitter.com/theweeknd",
    "carouselImageUrls": "[https://example.com/image1.jpg, https://example.com/image2.jpg]",
    "createdAt": "2025-09-18T12:34:56Z"
  }
}

json

application/json

auth-controller health-controller