<!-- Generated from https://developers.superfrete.com/openapi.yaml (operationId: getUser). -->

# Consultar conta

> `GET /api/v0/user` · Referência interativa: https://developers.superfrete.com/referencia#getUser

- **Method:** `GET`
- **Path:** `/api/v0/user`
- **Operation ID:** `getUser`
- **Tags:** Usuário

Devolve os dados da conta dona do token: nome, telefone, e-mail, CPF, saldo da carteira e limite de etiquetas em aberto.

- `limits.shipments`: etiquetas emitidas que ainda aguardam postagem.
- `limits.shipments_available`: quantas etiquetas ainda podem ser pagas antes de atingir o limite. Com `0`, o pagamento por API é recusado até que alguma etiqueta seja postada.
- `balance`: saldo da carteira, em reais.

## Effective servers

- `https://sandbox.superfrete.com`

  Sandbox (testes, etiquetas sem validade)
- `https://api.superfrete.com`

  Produção

## Authentication

- **bearerAuth**: HTTP bearer (`JWT`)

  Token de acesso da SuperFrete, no header `Authorization: Bearer {token}`.
  - **Integração da própria loja:** gere o token no painel, em **Integrações** ([produção](https://web.superfrete.com/#/integrations) ou [sandbox](https://sandbox.superfrete.com/#/integrations)).
  - **Plataforma que conecta várias contas:** obtenha um token por seller com o fluxo OAuth 2.0 ([`exchangeOAuthToken`](https://developers.superfrete.com/referencia/md/exchangeOAuthToken.md)).

  O token não expira e dá acesso a todas as rotas da API para a conta; não há escopos. Ele deixa de valer quando a integração é removida no painel. O token de sandbox só funciona no sandbox, e o de produção só em produção.

## Header parameters

- **`User-Agent` (required)**: `string`

  Nome da sua aplicação com um e-mail de contato técnico, no formato `Aplicação (email@exemplo.com)`. Hoje só [Listar pedidos](https://developers.superfrete.com/referencia/md/listOrders.md) recusa um valor fora desse formato, mas envie em todas as rotas.

  **Example:**

  ```json
  "MinhaLoja (dev@minhaloja.com.br)"
  ```

## Responses

### 200 Dados da conta.

**Content type:** `application/json`

- **`balance`**: `number`

  Saldo da carteira, em reais.
- **`document`**: `string | null`

  CPF da conta.
- **`email`**: `string`
- **`firstname`**: `string`

  Primeiro nome.
- **`id`**: `string`

  ID da conta.
- **`lastname`**: `string`

  Restante do nome.
- **`limits`**: `object`
  - **`shipments`**: `integer`

    Etiquetas aguardando postagem.
  - **`shipments_available`**: `integer`

    Etiquetas que ainda podem ser pagas.
- **`phone`**: `string`

  Telefone cadastrado.

**Example:**

```json
{
  "id": "3kCKGqzlPFfCEj2X1Tkob07SN2M2",
  "firstname": "Mariana",
  "lastname": "Souza Lima",
  "phone": "+5511912345678",
  "email": "mariana@lojaaurora.com.br",
  "document": "52998224725",
  "limits": {
    "shipments": 3,
    "shipments_available": 47
  },
  "balance": 1763.04
}
```

### 400 Conta não encontrada.

**Content type:** `application/json`

schema: `Error`

Erro de regra de negócio ou de autenticação. `message` e `error` trazem o mesmo texto.

- **`error` (required)**: `string`

  Mesmo conteúdo de `message`, mantido por compatibilidade.
- **`message` (required)**: `string`

  Mensagem legível do erro.

**Example:**

```json
{
  "message": "Usuário não encontrado!",
  "error": "Usuário não encontrado!"
}
```

### 401 Token ausente, inválido, removido ou de outro ambiente.

**Content type:** `application/json`

*Schema `Error` is shown above.*

**Example:**

```json
{
  "message": "Token inválida!",
  "error": "Token inválida!"
}
```

### 500 Erro interno. O corpo pode ser um objeto de erro ou só um texto JSON com a mensagem.

**Content type:** `application/json`

**One of:**

- *Schema `Error` is shown above.*
- `string`

**Example:**

```json
{
  "message": "",
  "error": ""
}
```

## Schemas

- `Error` — shown above.