# labels.listUids

List message sync index for a label.

Returns compact message records (UID, MODSEQ, flags, size, dates) ordered by UID for efficient folder synchronization (up to 10,000 per page).

```ts
openemail.labels.listUids(
  mailboxId: string,
  label: string,
  options?: LabelsListUidsOptions,
): ApiPromise<LabelUidPage>
```

It calls `GET /mailboxes/{mailboxId}/labels/{label}/uids`: [List message sync index for a label](/docs/api/labels/get_LabelUidList) in the API reference.

## Example

```ts
const labelUidPage = await openemail.labels.listUids(mailboxId, label)
```

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `mailboxId` | `string` | Mailbox ULID identifier. The path's `{mailboxId}`. |
| `label` | `string` | Label or folder name (e.g. INBOX, Archive, custom). The path's `{label}`. |

## Options

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

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `uidMin` | `number` | query `uidMin` | Minimum UID inclusive |
| `uidMax` | `number` | query `uidMax` | Maximum UID inclusive |
| `limit` | `number` | query `limit` | Maximum items to return (default 1000, max 10000) |
| `order` | `('asc' \| 'desc')` | query `order` | UID order within the page (default asc). `desc` pages from the newest end, for a client that must keep the NEWEST N under a row cap. |

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, [`LabelUidPage`](/docs/sdks/typescript/types/label-uid-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 UID range or limit |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Mailbox or label not found |
| `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: [`LabelUidPage`](/docs/sdks/typescript/types/label-uid-page).
