---
title: "Get user profile"
method: GET
path: "/api/user/profile"
tags: ["User"]
---

# Get user profile

`GET /api/user/profile`

## Request

- Base URL: `https://api.zvid.io`
- URL: `https://api.zvid.io/api/user/profile`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Retrieve the authenticated user's profile information and credit balance

## Response `200`

User profile retrieved successfully

- UserProfile
  - `user` object, required
    - `id` integer, required
    - `email` string, email, required
    - `firstName` string
    - `lastName` string
    - `emailVerified` boolean, required
    - `profileCompleted` boolean
    - `pendingRedirect` string, nullable
    - `isAdmin` boolean
    - `createdAt` string, date-time, required
  - `credits` CreditBalance, required
    - `balance` integer, required: Total available credits from subscription and add-on pools
    - `subscriptionCredits` integer, required: Credits remaining in the current subscription period
    - `addonCredits` object, required: Add-on credit pool and historical add-on totals
      - `balance` integer, required: Available add-on credits
      - `totalEarned` integer, required: Total add-on credits earned over all time
      - `totalSpent` integer, required: Total add-on credits spent over all time
  - `plan` object: Current plan and enforced account allowances. A null count means unlimited; absent values are unavailable.
    - `name` string
    - `isPaid` boolean
    - `uploadStorageBytes` integer, nullable
    - `maxProjects` integer, nullable
    - `maxDesigns` integer, nullable
    - `maxApiKeys` integer, nullable
    - `maxTemplates` integer, nullable
    - `outputRetentionDays` integer, nullable
    - `outputRetentionMonths` integer, nullable
    - `apiRequestsLimitPerHour` integer, nullable
    - `apiRequestsLimitPerMinute` integer, nullable

## Other responses

- `401`: Unauthorized - Invalid or missing API key
- `404`: User not found
- `500`: Internal server error

---

[API](https://skmtc.dev/zvid/apis/zvid-api.md) · [All operations](https://skmtc.dev/zvid/apis/zvid-api/llms.txt) · [OpenAPI document](https://skmtc.dev/zvid/apis/zvid-api/revisions/8a665b293b37?raw)