---
title: "api schema"
description: "Show operation schema"
canonical: "https://pgbeam.com/docs/cli/api/schema"
last-updated: "2026-09-14T19:37:21.000Z"
---

# api schema

> Show operation schema

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

Show the contract schema for an API operation: HTTP method and path, every parameter (name, location, required, type), the request body shape, and the success response shape. You can look up operations by their `tag.method` name (e.g. `projects.listProjects`), by operationId, or by route string.

## Usage

## Options

Option

Description

Required

Default

`<operation>`

Operation name in tag.method format (e.g. projects.listProjects), operationId, or route string

Yes

-

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

## Examples

## Output

Displays the operation, tag, HTTP method, path, parameters (name, location, required, type), request body shape, and response shape. With `--json`, returns the full operation schema object.