# mailboxes.get

Get mailbox details and usage statistics.

Returns mailbox metadata, current storage usage, message counts, trash metrics, database size, and realtime socket connection stats.

```ts
openemail.mailboxes.get(
  mailboxId: string,
  options?: CallOptions,
): ApiPromise<MailboxWithStats>
```

It calls `GET /mailboxes/{mailboxId}`: [Get mailbox details and usage statistics](/docs/api/mailboxes/get_MailboxGet) in the API reference.

## Example

```ts
const mailboxWithStats = await openemail.mailboxes.get(mailboxId)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |

## Options

It takes no options of its own. Every call also takes `signal`, `timeout`, `retry` and `headers`, which say how that one call is sent ([call options](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`MailboxWithStats`](/docs/sdks/typescript/types/mailbox-with-stats). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox not found or not accessible to this principal |
| `503` | temporary_failure: the mail store could not report its usage just now (a storage fault, or no answer within a few seconds); retry after the Retry-After window |

A failed call rejects with a [`RequestError`](/docs/sdks/typescript/errors): its `status`, and its `code`, the API's `error`. Decide on the code: one status covers several.

## Types

It names these types of the API, each on a page of its own: [`MailboxWithStats`](/docs/sdks/typescript/types/mailbox-with-stats).
