auth.v1.ProfileService

GetProfile

Get the caller's profile.

Method

POST

Path

auth.v1.ProfileService/GetProfile

Service

auth.v1.ProfileService

Visibility

Authentication required

Authentication

Session token

MFA Requirement

Not required

POST

auth.v1.ProfileService/GetProfile

Request

Testnet

curl --request POST \ \
  --url 'https://api.testnet.polyester.com/auth.v1.ProfileService/GetProfile' \
  --header 'Content-Type: application/json' \
  --header 'Connect-Protocol-Version: 1' \
  --data '{}'

Responses

{
  "avatarUrl": "https://placehold.co/128x128.png",
  "bio": "Professional crypto trader and liquidity provider.",
  "createdAt": "2025-01-01T00:00:00Z",
  "currentTermsAccepted": false,
  "discord": "polyester_trader",
  "discordVerified": false,
  "nextUsernameChangeAt": "2025-01-01T00:00:00Z",
  "twitter": "@polyester_exchange",
  "twitterVerified": false,
  "username": "trader_alpha",
  "usernameUnlocked": false,
  "vipTier": 1,
  "website": "https://example.com"
}

Request

auth.v1.GetProfileRequest

Response

auth.v1.UserProfile

username string max 32 chars /^[a-zA…3,32}$/

Public username for the root account. Usernames are unique case-insensitively and use 3 to 32 letters, digits, underscores, dots, or hyphens. Empty means no username is set.

bio string max 256 chars

Short public bio. Maximum length is 256 characters.

website string max 256 chars

Public website URL, if set. Maximum length is 256 characters.

twitter string max 15 chars /^[A-Za…1,15}$/

X/Twitter handle without "@". Maximum length is 15 characters.

twitterVerified boolean

Whether the X/Twitter handle for this account has been verified.

discord string max 64 chars

Discord handle or username without "@". Maximum length is 64 characters.

discordVerified boolean

Whether the Discord handle for this account has been verified.

avatarUrl string max 256 chars

Avatar URL, if set. Maximum length is 256 characters.

createdAt string (date-time)

Account creation time in UTC. This is the canonical "member since" timestamp.

nextUsernameChangeAt string (date-time)

Next time in UTC when the username can be changed again. Omitted when no cooldown applies.

vipTier integer (int32)

Current VIP tier for this root account. A value of 0 is the base tier. Read-only.

usernameUnlocked boolean

Whether this account is currently allowed to claim/change a username.

currentTermsAccepted boolean

Whether the caller's root account accepted the terms required for restricted actions. False when the required terms have not been accepted.

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.