Skip to content

Get User Profile

GET
/api/v1/user/profile

Get the authenticated user’s profile

User profile

object
success
required
boolean
data
required
object
id
required

User ID

string format: uuid
Example
550e8400-e29b-41d4-a716-446655440000
email
required

User email

string format: email
Example
user@example.com
fullName
required

User’s full name

string | null
Example
John Doe
avatarUrl
required

Profile picture URL

string | null format: uri
subscriptionTier
required

Current subscription tier

string
Allowed values: free starter pro enterprise
Example
pro
subscriptionStatus
required

Subscription status

string
Allowed values: active trialing past_due canceled incomplete
Example
active
trialEndsAt
required

Trial end date (if applicable)

string | null format: date-time
Example
2024-01-15T10:30:00Z
currentPeriodEnd
required

Current billing period end date

string | null format: date-time
Example
2024-01-15T10:30:00Z
createdAt
required

Account creation date

string format: date-time
Example
2024-01-15T10:30:00Z
updatedAt
required

Last profile update

string format: date-time
Example
2024-01-15T10:30:00Z
meta
required
object
timestamp
required

Timestamp in ISO 8601 format

string format: date-time
Example
2024-01-15T10:30:00Z

Unauthorized

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100