User API

Retrieve the authenticated user's profile and account information.

The User API provides access to the authenticated user's profile and account details.

All response bodies use snake_case field names.

Endpoints

GET/api/v1/user

Get Profile

GET/api/v1/user

Returns the profile and account information for the currently authenticated user.

Response Fields

idstring

Unique user ID

emailstring

User's email address

first_namestring or null

User's first name

last_namestring or null

User's last name

language_preferencestring

Preferred language code (default: "en")

created_atstring

ISO 8601 account creation timestamp

updated_atstring

ISO 8601 last update timestamp

plan_tierstring

Current plan: "entrepreneur", "pro", or "business"

subscription_statusstring or null

Stripe subscription status (e.g., "active", "past_due", "canceled")

current_period_endstring or null

ISO 8601 end date for the current billing period

storage_used_bytesinteger

Total file storage consumed in bytes

subdomainstring or null

Custom subdomain (e.g., "acme" for acme.nueform.io). Pro plan and above.

custom_domainstring or null

Custom domain (e.g., "forms.acme.com"). Pro plan and above.

custom_domain_verified_atstring or null

ISO 8601 timestamp when the custom domain was verified. null if pending.

Response

json

{
  "id": "665a0a1b2c3d4e5f6a7b8c9d",
  "email": "alice@example.com",
  "first_name": "Alice",
  "last_name": "Johnson",
  "language_preference": "en",
  "created_at": "2025-11-01T10:00:00.000Z",
  "updated_at": "2026-02-28T08:15:00.000Z",
  "plan_tier": "pro",
  "subscription_status": "active",
  "current_period_end": "2026-03-15T00:00:00.000Z",
  "storage_used_bytes": 52428800,
  "subdomain": "acme",
  "custom_domain": "forms.acme.com",
  "custom_domain_verified_at": "2026-01-20T14:30:00.000Z"
}

Code Examples

bash

curl -X GET "https://api.nueform.io/api/v1/user" \
  -H "Authorization: Bearer YOUR_API_KEY"

Error Responses

Standard error responses returned by this endpoint.

Error Codes

401Unauthorized

Missing or invalid API key

404Not Found

User not found

500Server Error

Internal server error

Error Example

json

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key",
    "status": 401
  }
}

Last updated: May 23, 2026