---
title: "Ionic Capacitor SDK: Checklists"
description: "Display onboarding checklists for your users with the Gleap Ionic Capacitor SDK. Follow the integration code examples."
url: https://docs.gleap.ai/en/articles/594-ionic-capacitor-sdk-checklists
collection: "Ionic / Capacitor"
updated: 2026-11-01
language: en
---

# Ionic Capacitor SDK: Checklists

Display onboarding checklists for your users with the Gleap Ionic Capacitor SDK. Follow the integration code examples.

Dive into a completely refreshed onboarding experience that will guide your users with gusto. The new checklist feature not only ensures your users are thoroughly onboarded but also keeps them deeply engaged. All of this is neatly packed inside our Gleap widget!

## Open the checklists overview

Open the checklists overview with the method below.

```js
Gleap.openChecklists({
  showBackButton: true,
});
```

## Open a checklist

Open a single checklist with the method below.

```js
Gleap.openChecklist({
  checklistId: "checklistId",
  showBackButton: true,
});
```

## Manually start a checklist

Checklists can be sent either through trigger rules or manually with the method below.

```js
Gleap.startChecklist({
  outboundId: "outboundId",
  showBackButton: true,
});
```

You can find the outboundId within the checklist editor.

> **Info:** Please note that SDK version 12.1.0 or higher is required to send checklists.

> **Note:** `openChecklists`, `openChecklist` and `startChecklist` are part of the TypeScript API and work on the web from SDK **v19.0.0**.

## Related

- [Ionic Capacitor SDK setup](https://docs.gleap.ai/en/articles/563-ionic-capacitor-sdk-setup.md)
- [Ionic Capacitor SDK: User identity](https://docs.gleap.ai/en/articles/564-ionic-capacitor-sdk-user-identity.md)
- [Ionic Capacitor SDK: Frontend tools](https://docs.gleap.ai/en/articles/565-ionic-capacitor-sdk-frontend-tools.md)
- [Ionic Capacitor SDK: Track events](https://docs.gleap.ai/en/articles/566-ionic-capacitor-sdk-track-events.md)
- [Ionic Capacitor SDK: Track pages](https://docs.gleap.ai/en/articles/567-ionic-capacitor-sdk-track-pages.md)