XBorg SDK
  • Introduction
  • Community
    • Details
    • Resources
    • Inventory
    • Prizes
    • Store
    • Achievements
  • User
    • Profile
    • Authentication
    • Socials
    • Wallets
  • Quests
    • User
    • Community
  • Quest Events
    • Details
    • Participation
    • Leaderboard
  • Blockchain
  • Configuration
  • Shared Library SDK
    • Authentication & Setup
    • Quest Management
    • Event Management
      • Working with Events
      • Events Lifecycle
      • Events Requirements
      • Events Quests
      • Events Rewards
    • Quest Rewards
    • 3D Avatar
Powered by GitBook
On this page
  1. User

Profile

The User Profile API provides a comprehensive set of endpoints to interact with a users data.

PreviousUserNextAuthentication

Last updated 4 months ago

Notifications

Return the profile of a user

get
Query parameters
fieldsstring[]Required
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/user/profile?fields=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return the public profile page of a user

get
Path parameters
usernamestringRequired
Query parameters
containerIdstringRequired
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/user/by-id/{username}/public?containerId=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return handles of users current user referred

get
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
get
GET /v1/user/referrals HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}
get
Query parameters
pagenumberOptional
limitnumberOptional
containerIdstringRequired
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/user/notifications?containerId=text HTTP/1.1
Host: 
Accept: */*

No content
post
Responses
201Success
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
post
POST /v1/user/notifications/read HTTP/1.1
Host: 
Accept: */*

No content
  • GETReturn the profile of a user
  • GETReturn the public profile page of a user
  • POSTUpdate the profile of a user
  • GETReturn handles of users current user referred
  • Notifications
  • GET/v1/user/notifications
  • POST/v1/user/notifications/read

Update the profile of a user

post
Body
displayNamestringOptional
handlestringOptional
biographystringOptional
dateOfBirthobjectOptional
Responses
400
Generic Client Error
application/json
401
Authentication related errors: - `GENERIC_UNAUTHORIZED`: Generic unauthorized access error. - `SESSION_TOKEN_EXPIRED`: User session has expired. - `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
default
application/json
post
POST /v1/user/profile HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "displayName": "text",
  "handle": "text",
  "biography": "text",
  "dateOfBirth": {}
}
{
  "code": 10002,
  "message": "generic_client_error"
}