# schedulingInbox.list

List arriving scheduling messages.

What arrived for this identity and what became of it — applied, or refused and why. The scheduling Inbox RFC 6638 clients read. Owner-only.

```ts
openemail.schedulingInbox.list(
  identityId: string,
  options?: SchedulingInboxListOptions,
): ApiPromise<SchedulingInboxPage>
```

It calls `GET /identities/{identityId}/scheduling-inbox`: [List arriving scheduling messages](/docs/api/pim/get_SchedulingInbox) in the API reference.

## Example

```ts
const schedulingInboxPage = await openemail.schedulingInbox.list(identityId)
```

## Arguments

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

## Options

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

| Option | Type | Sent as | Description |
| --- | --- | --- | --- |
| `limit` | `number` | query `limit` | Page size, default and max 200 |
| `pending` | `boolean` | query `pending` | `true` lists only the Inbox members: held messages the client has not yet DELETEd |

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, [`SchedulingInboxPage`](/docs/sdks/typescript/types/scheduling-inbox-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 |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Identity not found, or not this principal's |
| `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: [`SchedulingInboxPage`](/docs/sdks/typescript/types/scheduling-inbox-page).
