Skip to content
This repository was archived by the owner on Nov 21, 2025. It is now read-only.

Profile related endpoints

Jump to bottom
Ramza edited this page Feb 1, 2024 · 2 revisions

Create a new profile

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

POST /api/v1/users/{userid}/profiles

Expected Parameters:

  • DisplayName
  • TagName

Returns:

  • UserID

Get by User ID

GET /api/v1/profiles/{userid}

Returns:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Get by Tag Name

GET /api/v1/profiles/{tagname}

Returns:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Get followers by User ID

GET /api/v1/profiles/{userid}/followers

Returns an array of:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Get followers by Tag Name

GET /api/v1/profiles/{tagname}/followers

Returns an array of:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Get follows by User ID

GET /api/v1/profiles/{userid}/follows

Returns an array of:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Get follows by Tag Name

GET /api/v1/profiles/{tagname}/follows

Returns an array of:

  • UserID
  • DisplayName
  • TagName
  • PicturePath
  • BackgroundPath
  • Followers
  • Follows

Update Tag Name

PUT /api/v1/profiles/{userid}/tagname

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Expected parameters:

  • TagName

Update Display Name

PUT /api/v1/profiles/{userid}/displayname

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Expected parameters:

  • DisplayName

Update Picture Path

PUT /api/v1/profiles/{userid}/picturepath

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Expected parameters:

  • PicturePath

Update Background Path

PUT /api/v1/profiles/{userid}/backgroundpath

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Expected parameters:

  • BackgroundPath

Delete

DELETE /api/v1/profiles{userid}

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Add like

POST /api/v1/profiles/{userid}/follows/{followedid}

Requires Authorization Bearer header with a valid JWT token corresponding to the userid.

Delete like

DELETE /api/v1/profiles/{userid}/follows/{followedid}

Clone this wiki locally