> ## Documentation Index
> Fetch the complete documentation index at: https://vetta.sh/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# miniApps

> The company's mini apps, read with live numbers — client.miniApps.

Two methods. A mini app is a small app of the dashboard made of the platform's blocks; a template
declares its mini apps, each with pages. See [Mini apps](/docs/api/mini-apps) for the shape of a read page.

## list

```ts theme={"system"}
client.miniApps.list(): Promise<{ data: MiniAppSummary[]; has_more: boolean; next_cursor: string | null }>
```

`GET /v1/mini-apps`. The mini apps in the template's order: each `{ object: "mini_app", slug, name, icon, pages, reads }`, where `reads` names the sources its pages read.

## get

```ts theme={"system"}
client.miniApps.get(slug: string, page?: string): Promise<MiniApp>
```

`GET /v1/mini-apps/{slug}?page=`. One page with every block read now, on the company's clock: the
named page, else the first. A block that could not be read is an `Unread` element with its reason.
Spend is read only for a caller holding `billing:read`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.