| Format | Flag | Best for |
|---|---|---|
| Pretty | (default in a terminal) | Reading a result yourself. |
| JSON | --json | Machine-readable payloads with pagination metadata. |
| Quiet | --quiet | Piping an identifier into another command or jq. |
| TOON | --toon | Feeding list/show output back to an LLM (fewer tokens than JSON). |
--toon > --quiet > --json > pretty.
Pretty
The default when writing to a terminal — tables for lists, key-value pairs for a single record. Not intended for machine consumption.JSON
The JSON envelope wraps the resource body along with breadcrumbs and, for list commands, pagination:data is the array of records itself — the resource key from the API response is unwrapped. For show, create, and update, data is the single-record body as the API returns it, such as { "booking": { ... } }.
breadcrumbs is omitted when empty, and pagination is present only for list commands. JSON is used automatically when output is piped (a non-TTY), or force it with --json.
Quiet
--quiet emits only the data payload — no envelope. For action commands (create / update) it prints just the resource identifier; for delete it prints success. This makes it ideal for scripting:
TOON
--toon re-encodes the same data as TOON (Token-Optimized Output Notation) — the same shape as JSON with compressed whitespace and keys, typically 30–60% fewer tokens. Prefer it when handing list or show output to an AI assistant.
Pagination
List commands page their results. Two flags control paging, and thepagination block in the JSON envelope tells you where you are in the result set.
Pagination Parameters
The page of results to retrieve, starting from 1.
The number of records to return per page (max 100).
Example Usage
Response Structure
For list commands the JSON envelope carries apagination block alongside the data:
The total number of records across all pages.
The total number of pages available.
The page you are currently on.
The number of records returned per page.
Default Behavior
Omit both flags and the CLI sends no paging parameters, so the server defaults apply: the first page with 30 records per page. Set either flag to override —--page-size accepts up to 100.
Best Practices
- To walk every page, increment
--pageuntilcurrent_page_number == total_pages. - Use
--jsonor--toonwhen scripting so you can read thepaginationblock.--quietstrips the envelope, so pagination metadata is not available in quiet mode. - Read
total_recordsup front to size the work before you start paging.