# Zulu — full capability manifest for AI agents

> Generated from the module registry (data/modules.json) and the live OpenAPI spec.
> In production this file is built automatically so it never drifts from the API.
> Status legend: [LIVE] endpoints exist · [PARTIAL] some capability via related resource · [ROADMAP] no API yet.

API base: https://dashboard.getzulu.io/api/v1
Auth: Authorization: Bearer zulu_{64-hex}  (tenant key, scoped per user)
OpenAPI: https://getzulu.io/openapi.json
MCP server: @getzulu/mcp on npm — `claude mcp add getzulu -e ZULU_API_TOKEN=zulu_… -- npx -y @getzulu/mcp` (24 read-only tools over this API; local stdio transport)
CLI: @getzulu/cli on npm — `npm install -g @getzulu/cli`, then `getzulu setup`; commands read as `getzulu <resource> <action>` (alias `zulu`), raw API JSON out
Note: the MCP server and CLI are read-only today — for the write endpoints below (POST/PUT/DELETE), call the REST API directly.

## Account & onboarding  [LIVE]  (public, no auth)
- POST /account/signup — create a trial account (intended for an agent onboarding its owner). Body: { "fields": { "email", "name_first", "company", "modules": ["opt_client", "opt_sale", ...] } }. modules is required — use the exact opt_key shown in each module's section header below (NOT the module name or resource path; e.g. Digital Invoicing is opt_sale, not opt_invoice). The cheapest covering plan is auto-selected and returned under data.plan. Returns data.username, data.password (generated when omitted), data.api_key (live only after verification), data.trial_expires_at. Per-IP rate limited.
- POST /account/verify — activate a pending account. Body: { "fields": { "email" (or "account_id"), "code" } } where code is the 6-digit code emailed to the owner. Codes expire after 15 min and lock after 5 failed attempts. Once verified, the api_key issued at signup goes live.
- GET /account/modules — list the valid module keys for fields.modules (with display name + tier). No auth. Use this to avoid guessing keys — e.g. invoicing is opt_sale ("Digital Invoicing"), not opt_invoice.

## Sell & Get Paid

### Contact CRM  [LIVE]  resource: client  opt_key: opt_client
Create/update/search contacts, read records, log notes.
- GET /client | GET /client/{token} | POST /client | PUT /client/{token}
- GET /note/{object}/{token} | POST /note/{object}/{token}

### Digital Invoicing  [LIVE]  resource: invoice  opt_key: opt_sale
Create invoices, manage line items, read payment status.
- GET /invoice | GET /invoice/{token} | POST /invoice | PUT /invoice/{token}
- POST /invoice/{token}/line | PUT /invoice/{token}/line/{line_id} | DELETE /invoice/{token}/line/{line_id}

### Online Quoting  [ROADMAP]  resource: quote  opt_key: opt_quote
Pull pricing, build and send quotes, convert to invoice/order.

### Order Fulfilment  [ROADMAP]  resource: order  opt_key: opt_sale_fulfil
Create/track orders, update fulfilment, trigger shipments. Premium: sorder_automation, sale_fulfil_forex.

### Point of Sale  [ROADMAP]  resource: sale  opt_key: opt_sell
Create sales, read takings, reconcile. Premium: pos_dine.

### Subscription & Renewal Billing  [ROADMAP]  resource: subscription  opt_key: opt_renew
Create/manage subscriptions, read recurring revenue, dunning.

## Stock & Operations

### Product Database  [LIVE]  resource: product + category  opt_key: opt_product
Create/update products, pricing, images, categories/tags/brands, taxonomy. Manage categories as first-class records (CRUD) and assign/remove categories & tags per product. Premium: product_supersede.
- GET /product | POST /product | GET /product/{token} | PUT /product/{token} | GET /product/taxonomy
- POST /product/{token}/image | PUT /product/{token}/price
- PUT /product/{token}/category | PUT/DELETE /product/{token}/category/{category_token}
- PUT /product/{token}/tag | PUT/DELETE /product/{token}/tag/{tag_option_token}
- POST /category | GET /category/{token} | PUT /category/{token}

### Inventory Management  [PARTIAL]  resource: product.stock + porder  opt_key: opt_inventory
Read stock levels (ProductStock); raise/receive purchase orders. Roadmap: dedicated stock-movement & low-stock endpoints. Premium: product_batch.
- GET /product/{token} (stock) | POST /porder | POST /porder/{token}/line | GET /porder

### Purchasing & Suppliers  [LIVE]  resource: porder + supplier  opt_key: opt_supplier_purchasing
Manage suppliers, raise POs incl. forex, manage PO lines. Premium: porder_automation.
- GET /porder | GET /porder/{token} | POST /porder | PUT /porder/{token} | POST /porder/{token}/line
- GET /supplier | GET /supplier/{token} | POST /supplier | PUT /supplier/{token}

### Production & Manufacturing  [ROADMAP]  resource: production  opt_key: opt_production
### Asset Management  [ROADMAP]  resource: asset  opt_key: opt_asset

## People & Time

### Job Cards  [LIVE]  resource: jobcard  opt_key: opt_jobcard
Create/update/list job cards.
- GET /jobcard | GET /jobcard/{token} | POST /jobcard | PUT /jobcard/{token}

### Job & Project Management  [PARTIAL]  resource: job  opt_key: opt_job
### Staff & Timesheets  [ROADMAP]  resource: timesheet  opt_key: opt_staff
### Booking Scheduler  [ROADMAP]  resource: booking  opt_key: opt_schedule
### Event Ticketing  [ROADMAP]  resource: event  opt_key: opt_book
### Learning Library  [ROADMAP]  resource: course  opt_key: opt_learning
### Visitor Management  [ROADMAP]  resource: visitor  opt_key: opt_guestbook

## Run & Grow

### Digital Forms  [PARTIAL]  resource: form + form_submission  opt_key: opt_form_post
List/read forms with field definitions; list/read submissions with answer values (keyed by field slug), filterable by form, linked object and date range. Roadmap: create/prefill forms, trigger workflows off a submission.
- GET /form | GET /form/{identifier} | GET /form_submission | GET /form_submission/{token}
### Visual Pipeline (Kanban)  [ROADMAP]  resource: pipeline  opt_key: opt_pipeline
### Goals & Metrics (KPIs)  [ROADMAP]  resource: goal  opt_key: opt_kpi
### Sequences (Automation)  [ROADMAP]  resource: sequence  opt_key: opt_sequence
### Website Builder & CMS  [LIVE]  resource: post  opt_key: opt_website
- GET /post/{type} | GET /post/{type}/{identifier} | POST /post | PUT /post/{id}
### File Storage  [LIVE]  resource: file  opt_key: opt_file
- POST /file
### Support Ticketing  [ROADMAP]  resource: ticket  opt_key: opt_support

## Account & context
- GET /tenant_info  [LIVE] — account/tenant context
- GET /  [LIVE] — API status (public)

## Trial / limits
Free/trial accounts are capped (e.g. 10 clients, 5 quotes/month, 5 sales/month) until upgraded.
Plans bundle modules à la carte (standard/premium); extra users $25/month.