---
title: "Obter conta da company autenticada"
method: GET
path: "/api/v1/account"
tags: ["Conta e checkout"]
---

# Obter conta da company autenticada

`GET /api/v1/account`

## Request

- Base URL: `https://app.oportunidados.com.br`
- URL: `https://app.oportunidados.com.br/api/v1/account`
- Auth: OAuth 2 (authorization code, authorization URL `/oauth/authorize`, token URL `/oauth/token`; client credentials, token URL `/oauth/token`, scopes: `account_read`)

Conta da company do token OAuth: plano, cota de exportação, créditos bônus e pedido de mudança de plano pendente. Escopo `account_read`. 401 sem token e 403 de escopo insuficiente vêm do `doorkeeper_authorize!` e respondem `head`, sem corpo. Este endpoint não inclui `OauthEligibility`.

## Response `200`

sucesso

- object
  - `account` object, required
    - `id` integer, required
    - `name` string, required
    - `email` string, required
    - `phone` string, nullable, required
    - `suspended` boolean, nullable, required: Coluna `boolean DEFAULT false` SEM `NOT NULL`; `Company` não valida presença e o controller devolve o valor cru, então NULL chega ao cliente
    - `activated_at` string, date-time, nullable, required
    - `outstanding_since` string, date, nullable, required
    - `plan` object, nullable, required
      - `id` integer, required
      - `name` string, nullable, required: `plans.name` é `character varying` sem `NOT NULL` e `Plan` só valida `iugu_id`; o controller devolve o valor cru
    - `checkout_step` string, nullable, required
    - `user_count` integer, required
    - `export_limit` integer, required
    - `export_used` integer, required
    - `export_remaining` integer, required
    - `bonus_credits` integer, required
    - `pending_plan_change` object, nullable, required
      - `id` integer, required
      - `status` string, required
      - `change_type` string, nullable, required: Enum `integer` sem default nem validação de presença (`plan_change_request.rb:44`); a coluna é nullable
      - `from_plan` string, nullable, required
      - `to_plan` string, nullable, required
      - `cost_difference` string, required: Decimal serializado como string (BigDecimal no ActiveSupport JSON)
      - `requested_at` string, date-time, required
    - `created_at` string, date-time, required

## Other responses

- `401`: não autorizado — sem corpo (Doorkeeper responde head)
- `403`: escopo insuficiente — sem corpo (Doorkeeper responde head)

---

[API](https://skmtc.dev/oportunidados/apis/api-de-dados-oportunidados-v1.md) · [All operations](https://skmtc.dev/oportunidados/apis/api-de-dados-oportunidados-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/oportunidados/apis/api-de-dados-oportunidados-v1/revisions/0af33d72cdb4?raw)