PgBeam Docs
api

api ls

List all API endpoints

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

pgbeam api ls

Global options

All global options (--token, --profile, --project, --org, --json, --no-color, --debug) are also available on this command.

Examples

# 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.

On this page