Build on Forz

Sync Forz with your ERP, push jobs in from your own booking flow, or hand your AI agent the keys. The Public API v2 and the open-source Forz CLI come with Forz, with no separate add-on tier.

API reference CLI on npm

REST API

Public API v2

A versioned JSON API over HTTPS with an OpenAPI 3 reference. The records the office works with are within reach of your code: customers, sites, jobs, estimates, invoices, purchase orders and more.

  • Bearer auth with API keys you create in Forz
  • Cursor pagination on every list, with filtering, sorting and free-text search on the core resources
  • ETag-based optimistic concurrency on updates and deletes
  • Idempotency keys on financial creates
  • RFC 9457 problem+json errors with stable, documented codes
  • Rate-limit headers on every response, plus a staging server
Open the API reference

Forz CLI

npm: forz-cli

A zero-dependency TypeScript command-line tool and client library that bakes the API conventions in, so you never hand-build a cursor, ETag or idempotency key.

  • List, get, create, update and delete every core resource from the shell
  • Import ForzClient into your own Node or TypeScript code
  • Reads JSON bodies from a file, an argument or stdin for scripting
  • Escape hatch: forz raw for any endpoint in the reference
Read the CLI guide on npm

AI agents

Bring your own

The CLI package ships a Claude Code skill and an AGENTS.md file, so Claude, ChatGPT, Codex, Grok or your own agent can drive Forz with your API key and your AI account.

  • No Forz markup or metering on your AI provider's bill
  • Agent instructions cover the ETag, idempotency and pagination rules
  • A Forz Model Context Protocol (MCP) server is planned, not live yet
How Forz works with AI agents

Your first API call

  1. Check with our team that API access is turned on for your Forz account.
  2. Create an API key in Forz under Settings > API Keys.
  3. Install the CLI from npm and save the key with forz login, or send it as a Bearer token from your own code.
  4. Test against staging first, then point the same code at production with a production key.
Browse the endpoints Ask for API access 
# install the CLI and save your key
npm install -g forz-cli
forz login --token <your-api-key>
forz whoami

# list customers, then create a job from a file
forz customers list --limit 25 --q "Harbor"
forz jobs create --body @new-job.json

# or call the REST API directly
curl https://app.forz.io/api/v2/customers \
  -H "Authorization: Bearer <your-api-key>"

What the API covers

Resources in the Public API v2 today. The reference lists every field, filter and error code for each one.

  • Customers
  • Sites
  • Contacts
  • Jobs
  • Recurring jobs
  • Estimates
  • Invoices
  • Recurring invoices
  • Sales orders
  • Purchase orders
  • Vendors
  • Items
  • Assets
  • Systems
  • Tasks
  • Tickets
  • Leads
  • Deals
  • Projects
  • Notes
  • Custom fields
  • Lookups

Need an endpoint that isn't there yet? Tell us what you're building, and check the public roadmap for what's coming, including the MCP server.

Build your integration on Forz

Talk to our team about API access, staging credentials and what your integration needs. The API and CLI come with Forz.

Get Your Free Demo View Pricing
Free data migration Free 30-minute demo, no commitment