# labels.list

List mailbox labels and folder statistics.

Returns all system and custom labels with message counts, unread counts, UID validity, and next UID sequence numbers. Listing requires the lookup (`l`) right. With `name`, returns only that exact label's statistics and requires read (`r`) instead, so a reader can check a known folder without enumerating the mailbox. An unknown or out-of-scope name returns an empty labels array; wildcard characters are literal. For the owner identity, an unfiltered listing also reports how many sends are scheduled and not yet released, so a client can decide whether to offer a Scheduled view without a second request.

```ts
openemail.labels.list(
  mailboxId: string,
  options?: LabelsListOptions,
): ApiPromise<LabelListPage>
```

It calls `GET /mailboxes/{mailboxId}/labels`: [List mailbox labels and folder statistics](/docs/api/labels/get_LabelList) in the API reference.

## Example

```ts
const labelListPage = await openemail.labels.list(mailboxId)
```

## Arguments

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

## Options

The last argument, `options`, a `LabelsListOptions`, takes:

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `name` | `string` | query `name` | Exact label name for a read-authorized statistics query; no wildcard expansion |

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, [`LabelListPage`](/docs/sdks/typescript/types/label-list-page). 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 |
| --- | --- |
| `400` | validation_failed — malformed name |
| `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 platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description) |

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: [`LabelListPage`](/docs/sdks/typescript/types/label-list-page).
