Skip to Content
Developer APIOverview

Developer API

Clorvia has a full API so you can automate your books and connect Clorvia to your other software — your own app, an e‑commerce store, a POS, a spreadsheet tool, or any system that can make HTTPS requests.

Anything you can do in the Clorvia app, you can do through the API: create customers and items, raise GST invoices, record payments, read reports, and more.

What you get

  • API keys — secure, revocable keys scoped to a role, so a key can only do what that role is allowed to do. Manage API keys →
  • A simple REST API — plain HTTPS endpoints with JSON in and JSON out. List, create, update and delete any of your records (customers, items, invoices, payments…). This is the recommended way to integrate. REST API reference →
  • AI agents (MCP) — connect Claude or any AI agent with the Model Context Protocol and run your account in natural language. Connect an agent →
  • Webhooks — get a signed notification the moment something changes (an invoice is paid, a customer is created…) so you don’t have to keep polling. Set up webhooks →

How it fits together

  1. Create an API key in Settings → APIs & Webhooks and copy its token.
  2. Send REST requests with that token in the Authorization header.
  3. Optionally register webhooks so Clorvia pushes changes to your system in real time.

Quick start

# List your customers (parties)
curl https://api.clorvia.com/api/v1/parties \
  -H "Authorization: Bearer YOUR_API_KEY_TOKEN"
# Create a customer
curl -X POST https://api.clorvia.com/api/v1/parties \
  -H "Authorization: Bearer YOUR_API_KEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Acme Traders","gstin":"27ABCDE1234F1Z5"}'

See the full REST API reference for every endpoint, field, filtering, pagination, and examples.

Good to know

  • Every key and request is scoped to your workspace — the API can never reach another customer’s data, and it only exposes your business records (never internal/admin objects).
  • Keys respect roles: give an integration a read‑only role if it only needs to read.
  • The API requires an active subscription or trial. If your plan lapses, API calls return Subscription Not active until you renew.
  • All traffic is over HTTPS.
SecurityAPI Keys