Output formats

Every command can return one of four output formats. In an interactive terminal, pretty output is the default. Use the flags below for machine-readable output.

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

If more than one is set, precedence is --toon > --quiet > --json > pretty. --verbose changes pretty output only, so it has no effect alongside the other three.

Global flags

These flags work on every command:

Flag	Description
`--json`	Output as JSON
`--quiet`	Output raw data only (no envelope)
`--toon`	Output in TOON format (token-optimized for AI agents)
`--verbose`	Expand every field of a record instead of a table
`--subdomain`	Override saved subdomain

--subdomain selects the signed-in workspace a command targets. See Authentication.

Pretty

The default in a terminal: tables for lists and key-value pairs for a single record. It is intended for people, not scripts. A table shows at most seven columns. The CLI picks identifier and name fields first (id, name, title, email, status, and similar), fills the remaining columns alphabetically, and keeps any URL fields as the last columns without truncating them.

neetoengage votes list --email sam@example.com

Verbose

--verbose prints every field of every record instead of a table, one label per line, with nested objects and lists indented underneath. Use it when a table leaves out a field you need.

neetoengage votes list --email sam@example.com --verbose

JSON

JSON wraps the resource body with breadcrumbs and, for list commands, pagination details:

{
  "data": [
    {
      "id": "7c1d4e92-3b58-4f06-a9d1-2e6f8b05c3a7",
      "title": "Export roadmap as CSV",
      "url": "https://acme.neetoengage.com/feature-requests/120-export-roadmap-as-csv",
      "admin_url": "https://acme.neetoengage.com/admin/feature-requests/120-export-roadmap-as-csv",
      "status": "Planned",
      "track": "Planned",
      "votes_count": 14,
      "created_at": "2026-09-02T10:15:30Z",
      "tag_number": 120
    }
  ],
  "breadcrumbs": [],
  "pagination": {
    "current_page_number": 1,
    "total_pages": 1,
    "total_records": 1,
    "page_size": 25
  }
}

For list commands, data is the array of records; the CLI removes the API response’s resource key. For show, create, and update, data holds the API response body, such as the feature request object for feature-requests create. breadcrumbs is omitted when empty, and pagination appears only on list commands. The CLI automatically uses JSON when output is piped (a non-TTY); use --json to force it.

Quiet

--quiet returns only the data payload, with no envelope or breadcrumbs. Every NeetoEngage command prints the raw payload, so pipe it to jq to pick out a field. This is useful in scripts:

neetoengage feature-requests create \
  --title "Export roadmap as CSV" \
  --description "Let admins download the roadmap as a CSV file." \
  --customer-email sam@example.com \
  --note "Raised in support ticket 4821" --quiet | jq -r '.feature_request.admin_url'

TOON

--toon encodes the same data as TOON (Token-Optimized Output Notation). It keeps the JSON shape while compressing whitespace and keys, typically using 30-60% fewer tokens. Use it when giving list or show output to an AI assistant.

neetoengage feature-requests search --query "export" --toon

Pagination

List commands that page, such as votes list, changelogs list and feature-requests voters, return results in pages. feature-requests search and tracks list return one list with no pagination block. The flags below control paging, and the JSON envelope’s pagination block shows your position in the result set.

Pagination parameters

integer

The page of results to retrieve, starting from 1.

integer

The number of records to return per page (max 100).

Example usage

neetoengage votes list --email sam@example.com --page 2 --page-size 50

This returns the second page of feature requests the customer voted for, with 50 records per page.

Response structure

For list commands the JSON envelope carries a pagination block alongside the data:

{
  "pagination": {
    "total_records": 250,
    "total_pages": 5,
    "current_page_number": 2,
    "page_size": 50
  }
}

integer

The total number of records across all pages.

integer

The total number of pages available.

integer

The page you are currently on.

integer

The number of records returned per page.

Default behavior

If you omit both flags, the CLI lets the server use its defaults: page 1 with 25 records. Either flag overrides the defaults; --page-size accepts up to 100.

Best practices

To retrieve every page, increment --page until current_page_number == total_pages.
Use --json or --toon in scripts when you need the pagination block. --quiet removes the envelope, so it does not include pagination metadata.
Check total_records before you begin to estimate the work involved.

Getting started

Commands

Global flags

Pretty

Verbose

JSON

Quiet

TOON

Example usage

Response structure

Default behavior

Best practices

​Global flags

​Pretty

​Verbose

​JSON

​Quiet

​TOON

​Pagination

​Pagination parameters

​Example usage

​Response structure

​Default behavior

​Best practices

Global flags

Pretty

Verbose

JSON

Quiet

TOON

Pagination

Pagination parameters

Example usage

Response structure

Default behavior

Best practices