Commands

Making API calls from the terminal

CRUD Operations

godmode api stripe customers                          # List (GET)
godmode api stripe customers cus_123                  # Get (GET)
godmode api stripe customers email=test@test.com      # Create (POST)
godmode api stripe customers cus_123 -pa name=Updated # Update (PATCH)
godmode api stripe customers cus_123 -d               # Delete (DELETE)

Parameters

key=value — body field (JSON), implies POST
key==value — query parameter (URL)

godmode api stripe customers email=a@b.com name=Jane  # POST body
godmode api stripe customers limit==10                 # GET ?limit=10

Raw Path Mode

Bypass route matching with a leading /:

godmode api stripe /v1/customers
godmode api stripe /v1/customers/cus_123 -d

Explore

godmode api stripe --help
godmode api stripe customers --help
godmode api stripe --help --filter pay

Usage

Install and first steps

Flags

CLI flags and options

On this page

CRUD Operations Parameters Raw Path Mode Explore