inbox-zero-api

Inspect and manage Inbox Zero automation rules and inbox analytics through the public API CLI.

12.1k|1.5k|Updated Jul 12, 2023
One-click install
npx skills add https://github.com/elie222/inbox-zero --skill inbox-zero-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: inbox-zero-api
Source: https://github.com/elie222/inbox-zero/tree/main/clawhub/inbox-zero-api
Command: npx skills add https://github.com/elie222/inbox-zero --skill inbox-zero-api

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @inbox-zero/api, and includes references (resource) components.

What problem does it solve?

Managing Inbox Zero automation rules and reading inbox analytics normally requires browser interaction with the web app. This Skill lets you perform those tasks programmatically through the Inbox Zero public API CLI, using stable JSON output suitable for scripting and automation.

Core Features & Use Cases

  • Rule Management: List, read, create, update, and delete Inbox Zero automation rules via the inbox-zero-api rules commands, with full-replacement update semantics.
  • Inbox Analytics: Query email statistics such as per-period activity and response times through the stats commands.
  • Live Schema Inspection: Fetch the current OpenAPI schema with inbox-zero-api openapi --json before building rule payloads, no API key required.
  • Use Case: You want to change one condition on an existing rule. Fetch the rule with rules get, edit the JSON in a workspace file, then apply the full replacement with rules update --file.

Quick Start

Ask the assistant to list your current Inbox Zero rules as JSON using the inbox-zero-api CLI with your API key configured.

Frequently Asked Questions about inbox-zero-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I list my Inbox Zero rules from the command line?

Run `inbox-zero-api rules list --json` with your INBOX_ZERO_API_KEY set in the environment. The --json flag returns stable, machine-readable output suitable for scripting.

How do I update an Inbox Zero rule without losing existing settings?

The rules update command performs a full replacement, not a patch. First fetch the current rule with `inbox-zero-api rules get <id> --json`, edit the saved file, then apply it with `rules update <id> --file rule.json --json`.

How do I install the Inbox Zero API CLI?

Install it globally with `npm install -g @inbox-zero/api` or run it without installing via `npx @inbox-zero/api`. The executable name is inbox-zero-api.

Does the Inbox Zero API CLI work with self-hosted deployments?

Yes. Set the INBOX_ZERO_BASE_URL environment variable or run `inbox-zero-api config set base-url <url>` to point the CLI at a self-hosted or nonstandard deployment.

Which Inbox Zero CLI commands work without an API key?

Only `inbox-zero-api openapi --json` works without authentication, letting you inspect the live API schema. Authenticated commands like rules and stats require INBOX_ZERO_API_KEY.