Profile
The User Profile API provides a comprehensive set of endpoints to interact with a users data.
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"
}
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"
}
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: 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"
}
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"
}
Notifications
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
Last updated