bdy api list

$bdy api list|ls [options]

List Buddy API endpoints

OPTIONS

--context <name>

Connection and scope context: default, git, link or a saved name. Overrides the globally active context for this invocation.

--examples

Show only examples; with this flag --format accepts text, json or jsonl

--verbose

Show REST API requests, responses, timing and retries on stderr

-w, --workspace <domain>

Workspace URL handle. Can be set via variable: BUDDY_WORKSPACE

-p, --project <name>

Project name. Can be set via variable: BUDDY_PROJECT

-m, --method <method>

Filter endpoints by method (all, get, post, put, patch, delete). Default: all

-s, --search <phrase>

Filter endpoints by phrase

--format <text|json>

Output format: json, text. JSON CLI errors: {error:{code,message,hint}}, exit 1. Default: text (choices: "text", "json")

-h, --help

display help for command

Documentation for bdy v1.25.20

Last modified on Oct 14, 2026

Examples

Return the result as JSON
bdy api list --format json$