API do Usuário

Recupere o perfil e as informações da conta do usuário autenticado.

A API do Usuário fornece acesso ao perfil e aos detalhes da conta do usuário autenticado.

Todos os corpos de resposta usam nomes de campo em snake_case.

Endpoints

GET/api/v1/user

Obter Perfil

GET/api/v1/user

Retorna o perfil e as informações da conta do usuário autenticado no momento.

Campos da Resposta

idstring

ID único do usuário

emailstring

Endereço de e-mail do usuário

first_namestring or null

Primeiro nome do usuário

last_namestring or null

Sobrenome do usuário

language_preferencestring

Código do idioma preferido (padrão: "en")

created_atstring

Timestamp ISO 8601 de criação da conta

updated_atstring

Timestamp ISO 8601 da última atualização

plan_tierstring

Plano atual: "entrepreneur", "pro" ou "business"

subscription_statusstring or null

Status da assinatura no Stripe (por exemplo, "active", "past_due", "canceled")

current_period_endstring or null

Data de término ISO 8601 do período de cobrança atual

storage_used_bytesinteger

Total de armazenamento de arquivos consumido em bytes

subdomainstring or null

Subdomínio personalizado (por exemplo, "acme" para acme.nueform.io). Plano Pro e superiores.

custom_domainstring or null

Domínio personalizado (por exemplo, "forms.acme.com"). Plano Pro e superiores.

custom_domain_verified_atstring or null

Timestamp ISO 8601 de quando o domínio personalizado foi verificado. null se pendente.

Resposta

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"
}

Exemplos de Código

bash

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

Respostas de Erro

Respostas de erro padrão retornadas por este endpoint.

Códigos de Erro

401Unauthorized

Chave de API ausente ou inválida

404Not Found

Usuário não encontrado

500Server Error

Erro interno do servidor

Exemplo de Erro

json

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

Última atualização: 20 de julho de 2026