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

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

/v1/user/profile

HTTPcURLJavaScriptPython

GET /v1/user/profile?fields=text HTTP/1.1
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

/v1/user/by-id/{username}/public

HTTPcURLJavaScriptPython

GET /v1/user/by-id/{username}/public?containerId=text HTTP/1.1
Accept: */*

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

Update the profile of a user

post

Body

application/json

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

/v1/user/profile

HTTPcURLJavaScriptPython

POST /v1/user/profile HTTP/1.1
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

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

/v1/user/referrals

HTTPcURLJavaScriptPython

GET /v1/user/referrals HTTP/1.1
Accept: */*

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

Notifications

get

Query parameters

pagenumberOptional

limitnumberOptional

containerIdstringRequired

Responses

200Success

No content

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

/v1/user/notifications

HTTPcURLJavaScriptPython

GET /v1/user/notifications?containerId=text HTTP/1.1
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

/v1/user/notifications/read

HTTPcURLJavaScriptPython

POST /v1/user/notifications/read HTTP/1.1
Accept: */*

No content