# API

**Kind**: interface | **Module**: [Modals](https://docs.interop.io/desktop/reference/javascript/modals/index.md) | **Access**: `io.modals`

**Source**: https://docs.interop.io/desktop/reference/javascript/modals/api/index.html

Modals API.

## Properties

- **`alerts`** (`AlertsAPI`, required)
  Alerts API.
- **`dialogs`** (`DialogsAPI`, required)
  Dialogs API.
- **`version`** (`string`, required)
  Version of the Modals API.

## Methods

### getStatus

Retrieves the status of the Modals API. Use this to check whether the Modals API is available for usage
(e.g., dialogs and alerts can be disabled via the platform configuration).

```ts
() => Promise<ModalsStatus>
```

**Returns**: `Promise<ModalsStatus>`

## Related types

- [AlertsAPI](https://docs.interop.io/desktop/reference/javascript/modals/alertsapi/index.md)
- [DialogsAPI](https://docs.interop.io/desktop/reference/javascript/modals/dialogsapi/index.md)
- [ModalsStatus](https://docs.interop.io/desktop/reference/javascript/modals/modalsstatus/index.md)