---
title: "api ls"
description: "List all API endpoints"
canonical: "https://pgbeam.com/docs/cli/api/ls"
last-updated: "2026-10-30T02:48:39.000Z"
---

# api ls

> List all API endpoints

URL: https://pgbeam.com/docs/cli/api/ls

{/* Auto-generated from CLI commands. Do not edit. Run `pnpm generate:cli-docs` to regenerate. */}

List all available PgBeam API endpoints, grouped by tag. Shows the HTTP method, path, and operation name for each endpoint. Useful for discovering API operations before using `pgbeam api request` or `pgbeam api schema`.

## Usage

```bash
pgbeam api ls
```

> **Global options**
>
> All [global options](/docs/cli/global-options) (`--token`, `--profile`,
> `--project`, `--org`, `--json`, `--no-color`, `--no-trunc`, `--debug`) are
> also available on this command.

## Examples

```bash
# List all API endpoints
pgbeam api ls

# List endpoints as JSON
pgbeam api ls --json
```

## Output

Displays endpoints grouped by tag, with each entry showing the HTTP method, path, and operation name. With `--json`, returns an array of endpoint objects with method, path, tag, and operation fields.