Profile

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

Return the profile of a user

get
Query parameters
fieldsstring[]Required
Responses
400

Generic Client Error

application/json
get
/v1/user/profile
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
get
/v1/user/by-id/{username}/public
GET /v1/user/by-id/{username}/public?containerId=text HTTP/1.1
Host: 
Accept: */*

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

Update the profile of a user

post
Body
displayNamestringOptional
handlestringOptional
biographystringOptional
dateOfBirthobjectOptional
Responses
400

Generic Client Error

application/json
post
/v1/user/profile
POST /v1/user/profile HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 237

{
  "displayName": "text",
  "handle": "text",
  "biography": "text",
  "address": {
    "addressId": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "addressLine3": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  },
  "dateOfBirth": {}
}
{
  "code": 10002,
  "message": "generic_client_error"
}

Return handles of users current user referred

get
Responses
400

Generic Client Error

application/json
get
/v1/user/referrals
GET /v1/user/referrals HTTP/1.1
Host: 
Accept: */*

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

Notifications

get
Query parameters
pagenumberOptional
limitnumberOptional
containerIdstringRequired
Responses
200Success
No content
get
/v1/user/notifications
GET /v1/user/notifications?containerId=text HTTP/1.1
Host: 
Accept: */*

No content
post
Responses
201Success
No content
post
/v1/user/notifications/read
POST /v1/user/notifications/read HTTP/1.1
Host: 
Accept: */*

No content

PreviousUserNextAuthentication

Last updated