---
title: "Current account and credential"
method: GET
path: "/v1/me"
tags: ["account"]
---

# Current account and credential

`GET /v1/me`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/me`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bm_session`

Scope: any. Pending claim keys allowed.

## Response `200`

The account, its sign-in identities and the calling credential.

- Me
  - `account` Account, required
    - `id` string, required
    - `kind` 'human' | 'pending', required
    - `plan` 'free' | 'pro' | 'team' | 'scale', required
    - `status` 'active' | 'receive_only' | 'suspended' | 'deleting', required
    - `trust_level` integer, required
    - `risk_score` number, required
    - `used_bytes` integer, required
    - `extra_storage_bytes` integer, required
    - `primary_email` string
    - `display_name` string
    - `is_staff` boolean, required
    - `created_at` string, date-time, required
  - `identities` Identity[], required
    - `id` string, required
    - `provider` string, required
    - `email` string
    - `email_verified` boolean, required
    - `is_private_relay` boolean, required
    - `created_at` string, date-time, required
    - `last_login_at` string, date-time, nullable, required
  - `staff` boolean, required
  - `providers` string[], required: Sign-in providers enabled on this server.
  - `auth` object, required: The calling credential.
    - `kind` 'session' | 'api_key' | 'oauth' | 'pending', required
    - `scopes` string[], nullable, required
    - `mailbox_ids` string[], required: Empty = every mailbox in the account.
    - `client_id` string, required: OAuth client id
    - `staff` boolean, required

## Other responses

- `401`: Missing or invalid credentials (`unauthorized`, `invalid_token`).

---

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